如何写出高品质的技术文章

品质第一。

要写出高品质的技术文章，需遵循“品质第一”准则。

方法

文章要求

• 原创、专业、新颖、独特的见解、探索成果。

• 紧扣主题，内容丰富，说理透彻， 论据充足，实践为真；

• 文风严谨素雅、简洁扼要，或者 活泼而富有表现力；

• 有必要的参考文献和引用出处。
  
  

写作准则

• 确立中心思想，想要表达什么；
• 组织素材和论据，不超过三个；
• 每篇文章小而美，不要大而全；
• 逻辑清晰有条理，容易理解；
• 大主题仔细切分，串联成珠。
  
  

主要步骤

• 确立中心论题和写作目标；

• 确定主要内容；

• 建立整体结构；

• 使用丰富形式优化文章表现力；

• 编辑、润色、发布、推广。
  
  

表现形式

• 一目了然的文章整体结构；

• 合理连贯的文字、图、表、链接、引用。
  
  

考虑读者感受

• 实用知识点、技术点、技能点；
• 有代码实例可以学习和使用；
• 面试、晋升等；
• 面向初学者、大学生、初级工程师；

细则

• 内容严格把关；
• 结构清晰直观；
• 讲解生动易懂；
• 篇幅适中；
• 排版美观；
• 润色完善。
  
  

内容严格把关

• 原创性或独创性，写别人所未写。
• 非原创知识，讲解具有独创性。
• 技术内容通常是客观性强的。内容的准确性要反复 check ，避免出现低级错误而误导人。
• 整理性、总结性文章，务求系统严谨，自底向上贯通。
• 内容新颖，对人切实有帮助。
• 有亲身经历或实践经验为佳。
• 逻辑严谨，层层递进。
• 聚焦一点，透彻清晰。
• Talk is cheap, show me the code.
• 对于存在争议的地方，需主动指明。
• 文章内容出处，有具体的文献引用，不做无源之水。
• 没有错别字。
  
  

结构清晰直观

• 开发多种清晰直观、循序渐进的文章结构模板，符合人的阅读认知习惯。
• 首引尾结，有始有终。
• 问题求解：引子-分析-思路-算法-实现-优化-小结-参考文献。
• 技术学习：引子-使用-原理-实现-小结-参考文献。
• 整理总结：引子-抽象-思路-考量-优化-细节-小结-参考文献。
• 尽可能扁平化，标题层级结构不超过三层，最好两层或一层。
  
  

讲解生动易懂

• 思路和细节讲解清晰。
• 语言风格：直白、平实、严谨、略显俏皮。
• 适当打比方和作比喻，采取修辞手法。
• 图文并茂，悦心悦目。
• 适配不同水平的读者。
• 对于专业水平的人，简洁扼要。
• 对于中等水平的人，深入浅出。
• 对于非专业水平的人，通俗易懂。
  
  

篇幅适中

• 篇幅控制适中，不给读者造成过大的阅读压力（笔记除外）。
• 核心内容示例，不超过三个。
• 综合笔记类，最好给出提纲或导图。
  
  

排版美观

• 选择一个好的排版和模板，优化和使用它。
• 合理使用空白和空行。
• 合理的段距和字体间距。
• 样式保持一致性；样式包括字体、行距、字体距、标题等。
  
  

润色完善

• 对于内容、结构、讲解、篇幅、排版等进行润色修改，持续完善。