中文文档撰写指南 本项目旨在提供一份中文技术文档的编写指南。 以下是翻译的 Google 开源代码规范里的文档规范部分: Markdown 规范 README 规范 哲学 最佳实践 Google 还有一份更详细的开发者文档规范,规范了大量英文中的行文和标点符号的规范用法方方面面,与本主题关系稍远,没有翻译,有兴趣可以进一步参考。 没时间的话也可以先读一下 highlight 部分。 以下是收集整理的一些中文世界的主流规范: 阮一峰:中文技术文档的写作规范 @Sparanoid:《中文文案排版指北》 中国国家标准:GB/T 15834-2001 《标点符号用法》