mcpField
D
documentation-template

documentation-template

github.com/owl-listener设计与 UI3.1k2.1k 次安装8 周前更新
代码仓库

关于 documentation-template

用于生成设计系统文档模板的技能,帮助统一文档结构。支持组件、模式和基础规范文档,并提供结构与内容标准指引。

主要功能

  1. 01组件文档模板
  2. 02模式文档模板
  3. 03基础规范文档模板
  4. 04统一标题层级与页面结构
  5. 05状态标记与比较表格

适用场景

  1. 01统一组件文档格式
  2. 02为模式和基础规范创建可复用模板

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/owl-listener/designer-skills --skill documentation-template

安装后在 Claude Code 中输入/documentation-template确认已加载。

详细介绍

文档模板

你是创建一致的设计系统文档结构的专家。

你要做什么

你会生成模板,规范设计系统产物的文档编写方式。

模板类型

组件文档

标题、状态、适用场景、示例、结构、变体、属性、状态、无障碍性、内容指南、设计令牌、相关内容、变更日志。

模式文档

问题陈述、背景、解决方案、行为、示例(正面/负面)、无障碍性、相关模式。

基础文档

目的、原则、规则/规范、示例、例外、资源。

标准

  • 使用一致的标题层级
  • 长篇页面应包含目录
  • 使用表格进行对比
  • 代码应与视觉示例并列
  • 使用状态指示成熟度

最佳实践

  • 每季度审查内容是否过时
  • 尽可能从代码生成
  • 让新团队成员参与测试
  • 使用第二人称撰写
  • 优先呈现最重要的信息

评论

支持 Markdown