| 内容 | 术语表、格式规则、示例约定、语气与人称 |
|---|---|
| 范围 | 文档、界面文案、对外公告 |
| 落地 | 规范 + 检查工具 + 评审清单三方配合 |
规则示例
规则示例
术语：统一用“数据库主从”而非“主备/主从库”混用
界面元素：按钮用【确定】标注
代码路径：行内代码样式，完整可复制
标题：句子式，避免多重嵌套技术写作规范 Style Guide
写作规范统一术语、人称、格式与语气：如术语表、数字与单位写法、代码与界面元素标注方式、标题层级规则；团队统一规范能明显降低阅读与翻译成本。
易错点
- 规范太长：几十页没人读完，执行无从谈起
- 有规范无检查：写作习惯照旧，规范沦为摆设
数据来源与参考
- 技术写作公开规范（如 Google/Microsoft 写作风格指南）