## 怎么寫文檔
盡量使用簡單、直觀的語言去描述,不要使用晦澀,難以理解的長句子,合理使用標點符號。
文字是最簡單的表達方式,表格描述問題比文字更清晰直觀,圖片更直觀。遇到復雜的問題,最好不要只用文字去描述,能用表格就用表格,能做圖片就用圖片表示。
描述問題時,要從多個方面考慮,適當的時候加入場景化,這樣更有代入感,使人印象更深刻,更容易理解。
* * * * *
### 參考
[中文技術文檔的寫作規范 - 阮一峰的網絡日志](http://www.ruanyifeng.com/blog/2016/10/document_style_guide.html)
last update:2017-9-21 09:20:58