SuperAPI AI 工具集

code-docs

通用与其它

查看项目

更新于 10-16 00:00

技能介绍

用途:该技能定位为“文档守护者”,负责项目文档的权威性与代码一致性。文档被视为代码库的语义数字孪生,定义系统是什么、如何运作、如何验证;代码只是其中一种呈现。若文档与代码冲突,应以文档为准或有意更新文档,不能悄悄漂移。

主要能力:以行为优先、目标驱动的方式编写规格(先写 WHY,再写 WHAT 与 HOW),覆盖内部行为与协议契约,用 Given/When/Then 场景和 RFC 2119 的 MUST/SHOULD/MAY 表达需求强度。强调验证是一等公民:每个项目应有可发现的 docs/verification/strategy.md,说明工具、测试层级、套件、环境、证据、节奏和已知缺口,并区分机械检查通过和行为符合产品意图。支持文档本体建模(node_type、frontmatter、类型化链接)、增量式变更提案(ADDED/MODIFIED/REMOVED)、归档合并、索引自动生成、故事层记录工程记忆,以及项目清册维护。

使用方式:采用渐进式加载,不要一次读完。先读 refs/principles.md 做定位,再根据任务选择模式文件:Inquire(理解与审计,子代理默认)、Curate(单文档创建与更新)、Propose(多文档变更提案)、Sync(文档与代码对账)、Archive(归档合并)、Audit(本体不变量与文档健康检查)。仅在需要时加载对应 refs 文件与 ./templates/ 模板。INDEX.md 由 scripts/index.py 自动生成,禁止手改;根 AGENTS.md 需包含 docs/INDEX.md 指针。

适用场景:项目规格编写与维护、文档与实现同步、验证策略梳理、工程故事归档、文档健康审计。

限制:本技能只写文档,不写代码、不做架构决策;不静默删除文档,改为标记 deprecated 或移入 archive/;行为有歧义时应先提问而非猜测。文档未提供具体 CLI 安装命令、收费与平台信息,暂未提供。