组件文档用这Skill搭可复用骨架

生成组件、模式或规范的文档模板结构。

documentation-template 是给设计系统文档搭共用骨架的 Skill。它为组件、问题解决模式和基础规则安排不同栏目,让读者知道去哪里找参数、行为与例外。

组件页需要状态与可访问性,模式页则应先解释什么问题、何时适用。统一标题层级有助导航,不代表每页都必须填相同的长表格。

提供文档对象、读者和现有材料,可获得可复用框架。成熟度和更新日期要对应真实状态,生成自代码的字段也需核语义;空栏目不应编造内容填满。用新成员能否查到所需信息来验证,再按实际更新频率维护,模板本身不是已经写好的规格。

分类:设计创作

来源仓库:owl-listener/designer-skills

适合用来做什么

  • 为我的系统组件生成一个标准化的文档模板。
  • 请创建一个组件规格文档模板,包含所有必要部分。

安装 documentation-template

npx skills add https://www.iskills.cc/skills/owl-listener/designer-skills/documentation-template/SKILL.md

在本机终端执行安装命令。安装前请阅读原始说明,确认所需工具、账号和权限。

查看安装步骤 · 查看常见问题

查看 documentation-template 的用途与原始说明

浏览全部 Skill 指南