用途:把“写点文档”变成读者真正可用的文档。每篇文档只服务一种读者需求,用 Diátaxis 框架分类,沿用项目自身语气与文档栈,并在交付前对照代码库核验。支持三种模式:WRITE 写新文档、IMPROVE 改进现有文档、AUDIT 审计整个文档站。
主要能力:按四象限写作——教程(引导新手完成一次必成功体验)、操作指南(帮有基础用户完成具体目标)、参考(完整中立陈述机制事实)、解释(讲清背景与原因)。可撰写 README、CONTRIBUTING、ARCHITECTURE、ADR、CHANGELOG、Runbook、API 参考等开发者文档。
使用方式:WRITE 模式先侦察代码库与现有文档,再确认文档类型、目标读者、读者目标与范围,随后提出文件路径、标题大纲、象限与导航改动,等待明确批准后才动笔;写完后按评分表自检。IMPROVE 模式先判定页面象限,对照标准列出问题,核验旧代码片段与版本声明后重写。AUDIT 模式先清点页面、分类象限、绘制四象限缺口图,输出“页面→现状→象限→动作”的报告与重构映射,获批后再执行。
限制:不写营销文案、博客或发布公告;不写行内代码注释与 docstring;不编造代码中不存在的功能;不提交代码,只写文件并报告。未提供具体安装命令与价格信息。