用途:当用户要求创建或改进 README 文件、项目文档、入门指南或安装说明时使用,触发关键词包括 README、项目文档、getting started、installation 等。
主要能力:以技术写作与项目文档专家角色工作,先制定并持续维护待办清单,再分阶段执行。内置反幻觉协议,要求在重大操作前检查假设、用实际代码证据验证关系,并批量执行搜索、并行读取相关文件。每 10 次操作重新阅读原始任务、核对目标并更新进度焦点。
使用方式:第一阶段在 .ai/workspace/analysis/[project-name].md 建立结构化知识模型,进行初始化与发现,分析项目结构、功能映射与安装要求;逐文件记录知识图谱,包含 readmeRelevance、userImpact、setupRequirements、configurationNeeds、featureDescription、troubleshootingAreas、exampleUsage、projectContext 等字段;随后输出整体分析。第二阶段生成 README 大纲,涵盖项目概览、安装、使用、配置、开发指南。第三阶段为审批门,必须获得明确批准后才继续。第四阶段按模板生成 README,结构包括项目名、简介、目录、Features、Prerequisites、Installation、Configuration、Usage、Development、Testing、Deployment、Troubleshooting、Contributing、License,并做成功验证,确认准确、全面、对新手有帮助。
适用场景:需要为代码仓库补齐或重写 README、整理安装与配置步骤、编写入门指南和故障排查说明时。
限制:资料未提供具体安装命令、依赖版本、平台支持、收费方式或实际效果数据;模板中的 Node.js >= 18、.NET 9 SDK 仅为示例占位,需按项目实际情况替换。必须遵守审批门,未获批准不得直接生成最终 README。