## 怎么写文档 尽量使用简单、直观的语言去描述，不要使用晦涩，难以理解的长句子，合理使用标点符号。 文字是最简单的表达方式，表格描述问题比文字更清晰直观，图片更直观。遇到复杂的问题，最好不要只用文字去描述，能用表格就用表格，能做图片就用图片表示。 描述问题时，要从多个方面考虑，适当的时候加入场景化，这样更有代入感，使人印象更深刻，更容易理解。 * * * * * ### 参考 [中文技术文档的写作规范 - 阮一峰的网络日志](http://www.ruanyifeng.com/blog/2016/10/document_style_guide.html) last update：2017-9-21 09:20:58