用途:为软件项目创建、改进或审计 README.md 文档,基于已验证的项目信息撰写,遵循项目自身风格与受众,不强行套用通用模板。
主要能力:区分创建、改进、审计三类操作,按用户指令确定授权范围;按优先级检查项目事实来源,如项目文档、包清单与构建配置(pyproject.toml、package.json、Cargo.toml 等)、入口点与公共 API、CI/CD 与发布配置、仍准确的现有 README、注释与示例;当来源冲突时优先采用可执行配置,保留项目惯例,记录不确定项而非猜测。
使用方式:先判断操作类型,再读取所需参考文件,如 readme-structures.md 选择结构、voice-and-tone.md 把握语气、anti-patterns.md 检查问题、formatting-and-punctuation.md 处理标点、verification-and-failure.md 验证声明与处理缺失信息。按项目类型选择重点:库或 SDK 强调安装、快速开始、API 概览与示例;CLI 强调安装、用法、参数、示例与配置;服务或 API 强调端点、认证、请求响应示例与部署;模板或起始项目强调包含内容、定制方式与前置条件;内部或企业项目强调设置、访问、支持与惯例。交付前检查标题、代码块语言标签与链接有效性。
适用场景:项目缺少 README、入职文档缺失、README 过时或不清晰、需要审计 README 质量时。
限制:不得编造功能、兼容性声明、版本或路线图;缺失信息应明确标注,仅在用户要求草稿时使用占位符;不得用通用模板替换准确的 README;外部 README 仅作结构参考,且需用户确认后才能获取;生成文档中不使用长破折号。若现有 README 已准确反映项目,应说明而非重写。