Kivinsae's Nest
·
写好项目技术文档 - CH02. 文档标准设计
💡
原文中文，约4700字，阅读约需11分钟。
📝
内容提要
本文讨论了文档标准和规范的设计，以及文档协作的问题。标准和规范可以减少文档贡献中的问题，实现统一、无歧义的文档贡献系统。标准化包括参考表和行文风格指南。维护者团队对于文档一致性至关重要。技术文档是项目的门面，与官网同等重要。
🎯
关键要点
- 文档标准和规范的设计可以减少文档贡献中的问题，实现统一、无歧义的文档贡献系统。
- 文档的标准化包括参考表和行文风格指南，维护者团队对于文档一致性至关重要。
- 文档的协作比代码更复杂，贡献者的行文风格和语言规范差异较大。
- 文档标准和规范的目的是减少问题出现，实现文档的工业化管理。
- 文档规范可以分为四个部分：名词与概念参考表、行文风格指南、多语言的同步检查和文档所有权管理。
- 标准化代表精确、达意、全局统一的术语词典表，是文档规范的基础。
- 好的文档应使用简单陈述句，消除歧义，维护者团队的稳定性对文档风格一致性至关重要。
- 技术文档是项目的门面，良好的文档能为项目带来巨大的潜在声誉和长期价值。
➡️
