风格指南
欢迎使用中国技术传播共同体技术写作风格指南。
1. 总则
本章规定了技术写作风格指南的总体原则和适用范围。
2. 术语命名规范
本章规定了技术文档中术语和名称的使用规范。
3. 写作规范
本章规定了技术文档的写作风格和语言使用规范。
4. 格式规范
本章规定了技术文档的排版和格式要求。
5. UI 元素与操作描述
本章规定了用户界面元素的命名、操作描述的写法以及键盘快捷键的标准表示方式。
6. 图片与多媒体
本章规定了技术文档中截图、图表、图注以及替代文本的使用规范。
7. 国际化与本地化
本章规定了技术文档在国际化(i18n)和本地化(l10n)方面的写作要求,以确保文档内容适合翻译和跨文化传播。
8. 文档结构与模板
本章介绍技术文档的结构设计、信息架构原则以及 DITA 主题类型的使用规范。
9. 可访问性
本章介绍技术文档可访问性的要求和最佳实践,确保所有用户都能平等获取文档信息。
10. 版本管理与发布
本章规定了技术文档的版本管理策略、发布说明写法以及文档评审流程。