用途:从 spec 和代码出发,写出面向真实读者的可发布指南,与记录内部设计的 spec 分开。分两条轨道:dev-guide 面向贡献者、集成方与下游开发者,输出 docs/dev/{slug}.md;user-guide 面向终端用户,输出 docs/user/{slug}.md。docs/dev/ 与 docs/user/ 为默认约定,项目已有结构时以项目为准。
触发:用户说“写文档”“开发者指南”“用户指南”时,或 feature-acceptance 收尾推送时;onboard 完成后可补全基础文档骨架。主动推送用户拒绝后不再重复。
用法:开始前读 .codestable/attention.md,缺失视为骨架不完整。明确轨道、覆盖范围与信息来源,读方案 doc 的术语、接口契约与用户可见行为,并用 python .codestable/tools/search-yaml.py --dir docs/dev --filter doc_type=dev-guide --filter status=current 等命令检索已有指南。按轨道结构起草,frontmatter 含 doc_type、slug、component、status、summary、tags、last_reviewed,起草时 status 为 draft,用户 review 放行后写入并改为 current 与当天日期。
dev-guide 结构:概述、前置依赖、快速上手、核心概念(可选)、接口参考、常见场景、已知限制(可选)、相关文档。user-guide 结构:功能简介、前置条件(可选)、如何使用(步骤化,配截图占位)、常见问题、相关功能(可选)。
限制:只写面向目标读者的内容,不搬入实现提示或内部设计;术语与方案 doc 一致;代码示例须来自实际代码,不虚构接口。已有 guide 标 outdated 时任务改为更新;大改先留旧文标 outdated 再新写。写完未改 current、代码更新后未标 outdated、两份指南高度重叠或存放 spec 信息,均为应避免的坑。工作流关联:cs-feat-accept、cs-feat-design、cs-onboard、cs-arch、cs-decide、cs-trick、cs-libdoc。