cs-doc-api 是 CodeStable 工作流中的 API 参考文档技能,性质为参考导向(Reference),回答“X 的每个零件长什么样、怎么配”,与任务导向的 doc-tutorial 互补:doc-tutorial 引用 doc-api 做详细参考,doc-api 的“相关条目”链回 doc-tutorial。信息源是源码本身,类型、默认值、签名有唯一正确答案,核心规则是不靠猜、不复制改名、每个条目独立读源码。
使用前先执行 CodeStable preflight:读 .codestable/attention.md,缺失先 cs-onboard,不读外部 AI 入口替代。条目粒度按项目类型确定:UI 组件库一个组件一条目,工具函数库一个模块或函数族一条目,API Client 一个 endpoint 族一条目,CLI 工具一个子命令一条目;初始化阶段确认后需保持一致。产物不在 .codestable/ 下:条目文档写入 docs/api/{slug}.md,条目清单写入 docs/api/manifest.yaml;项目已有其他约定则以项目为准,开始前先确认。
工作流分三阶段。Phase 1 初始化:确认项目类型、条目粒度与输出路径,扫描 source_root 下源码,识别公开导出并分组,生成 manifest.yaml(条目初始 status: pending),用 validate-yaml.py --file docs/api/manifest.yaml --yaml-only 校验后交用户 review,用户可标 skipped、调整分类或合并拆分。Phase 2 生成:单条目模式适合 1-3 个条目或首次试跑,选定条目读源码、按模板生成、用户 review、落盘、validate-yaml.py --file {路径} --require doc_type --require entry --require status 校验,再在 manifest 标 status: current;批量模式适合大量 pending,先选 2-3 个不同 category 的代表条目做样板(状态先 draft),用户确认模板与风格后批量生成,其余条目逐条独立读源码并标 draft,整体 review 前先 validate-yaml.py --dir docs/api --require doc_type --require entry --require status 批量校验,确认后统一切为 current。批量硬规则:每条目独立读源码,不允许复制改名;样板确认不可跳;动态导出或代码生成等特殊结构暂标 skipped 加 note。
Phase 3 增量更新可在代码变更后进行,入口包括:用 search-yaml.py 搜 status=outdated;对比 manifest.yaml 中 last_scanned 之后变更的源码;用 search-yaml.py --sort-by last_reviewed --order asc 按最久未复核优先。更新时重读源码、对比已有文档、增量修改变化部分、validate-yaml.py 校验,并将 status 置 current、last_reviewed 置当天。
与其他工作流的关系:cs-feat-accept 验收后新增或修改公开接口会提示是否更新 doc-api;cs-feat-design 方案第 2 节可作补充信息源但以源码为准;cs-keep 的注意事项重合时交叉引用而不重复写。限制与注意:不扫清单就写文档可能遗漏或重复;不读源码写 API 参考会失去核心价值;把 spec 不变量或测试约束写进 doc-api 属越界;manifest 不要直接删行,应改 status: skipped 并写 note;源码中不存在的接口不得写入文档。