用途:为库的公开表面(组件/函数/命令/endpoint)逐条目生成参考文档,回答“X 的每个零件长什么样、怎么配”,与任务导向的 guidedoc 互补。信息源是源码本身,类型、默认值、签名以源码为唯一正确答案,不靠猜、不复制改名。
主要能力与流程: 一、初始化。确认项目类型、条目粒度(如一个组件或一个函数族)、输出路径,扫描源码目录识别公开导出并分组,生成 docs/api/manifest.yaml,条目初始 status: pending,校验后交给用户确认,可标 skipped 并写 note。 二、生成。单条目模式适合 1-3 条或试跑:读 source_files,按模板生成,用户 review 后落盘,更新 manifest 状态为 current。批量模式先出 2-3 篇不同 category 的样板,状态为 draft,用户确认模板与风格后再批量生成剩余条目(可用 subagent 并行),整体 review 后统一转 current。硬规则包括每条独立读源码、样板确认不可跳、动态导出或代码生成等特殊情况标 skipped 加 note。 三、增量更新。通过搜索 status=outdated、对比 last_scanned 后变更的源码文件、或按最久未复核排序找出待更新条目,重读源码后做增量更新并重新校验。
输出约定:条目文档写到 docs/api/{slug}.md,清单为 docs/api/manifest.yaml;项目已有 reference/ 或 components/ 等约定时以项目为准。开始前需读取 .codestable/attention.md,缺失则先补齐或运行 cs-onboard。校验命令示例:validate-yaml.py --file docs/api/manifest.yaml --yaml-only;search-yaml.py --sort-by last_reviewed --order asc。
适用场景:UI 组件库、工具函数库、API Client、CLI 工具的参考文档编写与维护;与 cs-guide 通过交叉引用互补,与 cs-feat-accept、cs-arch 联动处理接口变更。
限制与注意:不把 spec 信息(不变量、测试约束)写进 libdoc;源码接口不存在不得凭文档编造;manifest.yaml 不直接删行;与 guidedoc 内容高度重叠说明其中一份定位有误。具体模板、frontmatter 格式与更多配置细节暂未提供。