2.8 KiB
2.8 KiB
| title | description | keywords | tags | author | date | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 简介 | 本指南旨在规范中文技术文档的写作，提高可读性，统一风格，降低沟通成本。 |
|
|
7Wate | 2024-08-07 |
引言
本指南规范了一种中文写作风格，主要用于技术文档的编写。素材来源于互联网，为各家中文文案风格指南的综合，旨在对中文技术文档的语言风格、结构样式、内容元素、标点符号、格式排版等方面给出参考规范。我希望本指南的出现能为日后业界标准的建立贡献一点力量。
目的
- 提高中文文案的可读性。
- 统一文档风格，保证组织对外输出形象一致。
- 避免不同的文档作者对同一问题反复作出决策，降低与文档相关的沟通成本。
适用范围
- 为编写中文文档的作者（如产品研发人员、技术写作人员等）提供规范或建议。
- 审校文档过程中争议问题的裁决。
- 也可供软件界面、帮助文档等资料开发人员参考。
目录大纲
简介
- 技术文档的重要性
- 技术文档的类型
标点符号
- 标点符号的基本规则
- 常见的错误用法
命名约定
- 命名约定的重要性
- 常见的命名规则
语言风格
- 语言风格的定义
- 一致性和简洁性的重要性
文档内容
- 文档内容的构成
- 如何编写高质量的文档内容
文档结构
- 文档的基本结构
- 不同类型文档的结构差异
附录资料
- 附录的定义
- 附录的使用场景
使用原则
本指南是一本查询手册，建议初次阅读本指南时，先大致浏览目录章节结构，了解本指南涵盖的内容范围；之后就编写文档时碰到的实际问题，再回头查找相应规范。
修订和审查
- 定期修订：定期修订文档，以保持其准确性和时效性。
- 多人审查：邀请其他人审查文档，他们可能会发现你可能忽视的错误或者遗漏。
本指南主要针对中文技术文档的编写给出了一系列的规范和建议，包括语言风格、结构样式、内容元素、标点符号、格式排版等方面。我希望本指南能帮助你提高中文文档的编写质量，提高其可读性，同时也能减少与文档相关的沟通成本。