用途:为设计系统生成可复用的文档模板,统一组件、模式或指南的文档编写方式,适用于需要标准化设计系统文档结构的场景。
主要能力:提供三类模板。组件文档包含标题、状态、使用时机、示例、结构剖析、变体、属性、状态、无障碍、内容指南、令牌、相关项与变更日志;模式文档包含问题陈述、上下文、解决方案、行为、正反示例、无障碍与相关模式;基础文档包含目的、原则、规则与规格、示例、例外与资源。
使用方式:按需选择模板类型并填充内容。文档规范建议保持一致的标题层级,长页面添加目录,比较内容使用表格,代码与视觉并排展示,并用状态标识成熟度。
最佳实践:每季度审查文档时效性,尽可能从代码生成文档,用新成员测试可读性,使用第二人称写作,重要信息前置。
限制:资料未提供具体安装命令、平台支持、收费方式或实际效果说明,相关内容暂未提供。