1.2 体例说明
本节说明风格指南的体例
规则总共分三种类型:
- 必须
- 推荐
- 了解
R-001
必须
技术文档必须遵循本指南
所有对外发布的技术文档,包括用户手册、API 参考文档、安装与配置指南、发布说明等,必须遵循本风格指南的规定。
R-002
推荐
内部文档应参照本指南
内部技术文档(如设计文档、技术备忘录)应尽量参照本指南的规定编写,以保持团队内部的文档质量。
正确
本产品支持 Windows 10 及以上版本的操作系统。
错误
本产品支持 win10 以上系统。
正确示例使用了完整的产品名称和规范的表述方式,而错误示例使用了缩写和口语化表达。