Shixiang Wang

>上士闻道
勤而行之

《技术文档规范》阅读

王诗翔 · 2020-10-26

分类: thinking  
标签: 文档   doc  

今天把阮一峰的《中文技术文档的写作规范》扫读了一遍,与自己平时的写作以及写作时的操作相互验证,觉得有不少收获。其中我认为最有参考价值的属于「文档体系」和「标点符号」两节内容。

虽然说规矩是死的,人是活的,我们每个人写的内容从形式上来说有各自不同的写法,但如果能够遵循一个大致的规则,写作时的基本要素容易以比较固定的格式提炼和展示出来,读者也可以比较容易获取要点,舒坦地阅读。

Golang 的简洁和优雅也在此处,虽然说它限制了很多的形式创造,但规范出来了代码给人的简单美感。