写作的原则总结

## 写作技巧总结

先总结一下，后面再举例子.

1. 使用对话的方式说明问题，有很强的带入感。

2. 使用列表的方式总结问题，从形式上看调理比较清晰。

3. 结合图片文字的方式说明问题，图文并茂，在描述流程、架构、事物之间的关系的时候，使用图来说明较好。

4. 使用准确的标题描述问题，上下问呼应，读起来比较顺

5. 字体、图片颜色和字体大小搭配要合理

6. 标题做到见名知意。

7. 只截取关键的代码，这样做让文章比较简洁，读者也不会糊涂。

8. 写了问题总结，说明把问题彻底解决了，可以从一个问题提炼出处理类似问题的共性，对举一反三有很多帮助。

9. 对待问题要刨根问底，有临时方案、最终方案、兜底方案

10. 关键字高亮

11. 描述清楚了实际情况是怎么样，也把预期的情况描述清楚了。

12. 使用导航方便读者浏览

13. 有说明问题发生在那个项目，快速定位问题发生的业务场景，也能定位到相关人（分析师、产品是谁也能知道）

14. 图上有标注。快速精准的获取图上的信息，使用 图n 这样的标注可以快速的标注图片的位置。

15. 提前描述问题产生的原因，带着目的看文章，效率更高。

16. 给出了关键代码所在文件的位置，方便读者追溯源码。

17. 涉及到要描述多个关联关系的情况，使用流程图会更加简洁明了。例如，业务流程图、程序时序图等。

18. 使用了附录，能够保证行文逻辑不会被附录的内容打断。

19. 将代码放在代码块中，可以提高阅读体验。

20. 最好将问题来源描述清楚，这样可以更好的追溯问题。例如，反馈问题的邮件、微信截图、反馈问题人的联系方式。