用途:为某个软件产品建立一套“产品描述”文档仓库,把产品视为用户通过输入推进的大型状态图,按功能用平实语言、从用户视角描述,所有文档使用同一骨架,便于通过对比发现遗漏与不一致。文档先依据源码与测试起草,再对照运行中的产品人工验证,疑似缺陷集中到一个分诊文件。
主要能力:提供 references/ 下的模板与指南,包括 product-kinds.md(把模板映射到画布编辑器、Web 应用、CLI 或聊天产品)、README/goal/glossary 模板、八段式功能文档模板、验证与缺陷分诊模板,以及链接与锚点检查脚本 check-links.py。产出 README.md、goal.md、glossary.md、AGENTS.md、CLAUDE.md、按 {area}/{feature}.md 组织的功能文档、verification/ 清单和 bug-triage.md。
使用方式:分阶段推进。Phase 0 确定范围、事实来源、运行方式、排除项、仓库位置与产品形态;Phase 1 搭建 README、术语表和 goal;Phase 2 亲自写试点、基础文档和最复杂区域;Phase 3 用子代理并行起草其余文档;Phase 4 做一致性检查,运行 python3 {skill dir}/references/check-links.py {repo};Phase 5 编写验证清单并尽可能执行首轮验证;Phase 6 汇总缺陷分诊,是否向上游提交问题需用户确认。恢复或扩展已有仓库时从读取 AGENTS.md、README、goal、glossary 开始。
适用场景:需要为软件产品建立可维护、可验证、术语统一的用户视角功能文档集时。
限制:不得修改源仓库,仅作只读参考;无法从代码和测试确定的行为应写入“Open questions”,不得猜测;自动化验证不能单独作为文档已验证的依据;清单与分诊编号一经使用不得重编;资料未提供具体收费、价格、平台或效果信息。