SuperAPI AI 工具集

component-docs

写作与研究

查看项目

更新于 10-17 16:13

技能介绍

用途 component-docs 用于为单个组件撰写一条文档条目,尤其是设计系统或前端组件库中的组件。它强调“只写来源里有的内容”:从组件的代码、props 类型、样式、stories 以及真实调用点中提取事实,缺什么就标什么,不补全、不臆造。它不评价设计质量,也不发布文档。

主要能力

  • 按固定结构生成草稿:从 references/doc-format.md 复制九个标题,先建立空框架,再逐节填充。
  • 来源追溯:阅读组件代码、props 类型、样式与 stories,并把每一项记录为一条 Sources 行。
  • 查找真实用法:通过调用点搜索或用户提供的信息找到两个真实使用示例;真实用法数量会影响停止条件。
  • 冲突记录:追踪每个示例、变体、属性、状态与 token 来自哪个来源;来源之间的每一处分歧都写入 Conflicts,并附上可裁决的规则引用,或注明“no rule, not chosen”。
  • 逐字复制:token 名称与示例代码按原样逐字符复制。
  • 用法规则:最后编写 Usage rules,每条规则形如 rule/<component>-<slug>,包含条件、动作、理由、证据(两个调用点、带路径的测量、具名原则或当事人的话)以及一条带真实违规代码的 Don't: 行;无法用代码片段打破的规则会被删除。
  • 猜测标注:每条主观判断写入 Guessed at,每行一条。
  • 输出附带信息:条目之后输出 Sources、Conflicts、Guessed at,以及在规则引入门控时输出 Gates(问题及其默认值)。

使用方式 技能按步骤执行:先复制九个标题建空稿;再定位组件并阅读代码、props 类型、样式和 stories,记录来源;然后寻找两个真实调用点;接着逐项追踪来源并记录冲突;之后按来源事实填充各节;最后编写用法规则并复核 Done 清单。独立运行时,草稿保存到 docs/system/<name>.md,第一行为草稿注释,并为缺失的示例写出对应文件。回复开头给出路径、条目覆盖范围与状态,随后最多三个带默认值的问题,以及一条可直接粘贴用于推进下一步的提示。

停止条件

  • 缺少代码:无法为变体、属性或行为提供来源时停止。
  • 缺少变体列表(props 类型或 stories):猜测的列表会写成另一个组件的文档,因此停止。
  • 缺少任何真实或计划中的用法:虚构用法会被读者当作真实用法照抄,因此停止。若 props 类型中没有变体属性,则视为空列表,Variants 写为 None 并继续;一个真实用法、计划用法与已弃用的前身会被标注而非触发停止。停止时返回停止原因、已按节整理的既有事实,以及解锁所需的最小回复(例如“一个屏幕名称、是什么把该组件放上去的、显示了哪个变体”)。

适用场景 适用于组件库、设计系统的文档维护,尤其是需要可审计、可追溯来源的组件文档草稿。适合在已有代码、stories 和真实调用点的项目中补写单组件条目。

限制 不写没有来源的变体、属性、token 名称、示例或用法;计划用法必须标注为 planned;不为让章节完整而虚构状态或优先级顺序;看起来像 bug 的行为按原样记录,并附 Defect: 行说明用户影响与最小修复;不编辑被文档化的代码、stories 或规范;回复中的计数来自对保存文件执行 grep -o(草稿注释之下)。九个标题须按顺序出现,无来源的章节写 Not applicable: <原因>。