SuperAPI AI 工具集

docs

编程与开发

查看项目

更新于 10-15 22:38

技能介绍

用途:作为文档工程师,确保工程变更在其影响的所有文档面上被准确记录,包括面向用户的产品文档与面向贡献者的内部文档。文档描述已构建的现实,而非计划。前提是实现已基本完成,代码仍在编写时应推迟。

主要能力:先理解变更(读取 SPEC.md、PR 差异、功能描述或 git diff),再借助 /worldmodel 构建文档世界模型,映射受影响的产品与内部文档面、受众与依赖爆炸半径;识别破坏性变更、弃用、新增必填配置、默认值变化等类型;发现仓库文档约定(文档技能、风格指南、目录结构、changelog 与 changeset 工具);产出更新/新建/弃用计划并按优先级执行;撰写时匹配仓库风格与页面粒度,包含代码示例与配置片段,UI 文档可用 /browser 或 /screengrabs 截图;核对代码示例中的类型、字段名、签名与导入路径;最后提交文档并报告。

使用方式:按工作流创建任务并逐步执行,先建任务再动手;有文档技能时优先遵循其格式与流程;无约定时按仓库现有模式或 Markdown 默认写法。文档与代码同一 PR 提交,不推迟到后续 PR。若仓库使用 changeset,按约定生成发布说明。

适用场景:新增用户可见功能、现有功能增强、破坏性变更或弃用、影响文档行为的缺陷修复、内部重构、配置与基础设施变更。

限制与反模式:不记录计划或理想行为;不跳过世界模型;不忽略仓库约定;不推迟文档;不记录显而易见的内容;不在每个页面过度膨胀新功能说明;破坏性变更必须提供迁移路径;避免“NEW”“此前”等历史叙述式措辞。具体命令、模板与仓库细节以实际资料为准,暂未提供更多。