品质第一。
要写出高品质的技术文章，需遵循“品质第一”准则：
- 内容严格把关；
- 结构清晰直观；
- 讲解生动易懂；
- 篇幅适中；
- 排版美观；
- 润色完善。
内容严格把关
- 技术内容通常是客观性强的。内容的准确性要反复 check ，避免出现低级错误而误导人。
- 内容新颖，对人切实有帮助。
- 内容具有独创性或原创性。
- 有亲身经历或实践经验为佳。
- 逻辑严谨，层层递进。
- 图文并茂，悦心悦目。
- 聚焦一点，透彻清晰。
- Talk is cheap, show me the code.
- 对于存在争议的地方，需主动指明。
- 文章内容出处，有具体的文献引用，不做无源之水。
- 没有错别字。
结构清晰直观
- 开发多种清晰直观、循序渐进的文章结构模板，符合人的阅读认知习惯。
- 首引尾结，有始有终。
- 引子-分析-思路-算法-实现-优化-小结-参考文献。
- 引子-原理-实现-使用-小结-参考文献。
- 引子-抽象-思路-考量-优化-细节-小结-参考文献。
- 尽可能扁平化，标题层级结构不超过三层，最好两层或一层。
讲解生动易懂
-
思路和细节讲解清晰。
-
语言风格：直白、平实、严谨、略显俏皮。
-
适当打比方和作比喻，采取修辞手法。
-
适配不同水平的读者。
-
对于专业水平的人，简洁扼要。
-
对于中等水平的人，深入浅出。
-
对于非专业水平的人，通俗易懂。
篇幅适中
- 篇幅控制适中，不给读者造成过大的阅读压力。
- 核心内容示例，不超过三个。
- 综合笔记类，最好给出提纲或导图。
排版美观
- 选择一个好的排版和模板，优化和使用它。
- 合理使用空白和空行。
- 样式保持一致性；样式包括字体、行距、标题等。
润色完善
- 对于内容、结构、讲解、篇幅、排版等进行润色修改，持续完善。