需要统一设计系统文档结构时…

当团队要标准化设计系统各类文档（组件、模式、基础规范）的结构与写法时，用模板快速产出统一骨架。

适用场景

解决思路

1. 按文档类型选用对应模板：组件文档、模式文档、基础规范文档。
2. 组件文档包含：标题、状态、何时使用、示例、结构剖析（anatomy）、变体、props、状态、无障碍、内容指南、tokens、相关项、变更日志。
3. 模式文档包含：问题陈述、上下文、解决方案、行为、示例（正例/反例）、无障碍、相关模式。
4. 基础规范文档包含：目的、原则、规则/规格、示例、例外、资源。
5. 统一标题层级（heading hierarchy）。
6. 长页面添加目录（table of contents）。
7. 用表格做对比。
8. 代码与视觉稿并排呈现。
9. 用状态指示器标注成熟度。
10. 每季度审查文档新鲜度。
11. 尽可能从代码生成文档。
12. 用新成员测试文档可读性。
13. 使用第二人称撰写。
14. 把重要信息放在最前面。

适用边界 · 注意事项

• 需要撰写单个组件的具体规格内容时，应使用 component-spec 而非本模板。
• 仅需一次性临时说明、不追求结构统一时，无需套用模板。