用途
该技能用于审计、编写和验证 README 文件，服务于采用、操作、贡献或内部导览等场景。当仓库文档缺失、不准确或需要重写时使用。其核心理念是：创建 README 应满足实际读者的需要，并以仓库行为为依据；准确性和首次使用成功优先于宣传性完整。
主要能力
该技能支持三种工作模式：
- 审计（Audit）：报告准确性、覆盖面和可用性缺陷；仅在用户要求时才进行编辑。
- 修复（Repair）：更新特定薄弱或过时的章节。
- 生成（Generate）：在不存在 README 或明确要求重写时创建 README。
该技能会识别仓库类型和主要读者任务，包括：库或 SDK 采用；CLI 安装和首个命令；托管应用设置或贡献；服务操作和本地开发；monorepo 导航和包归属；标准、数据集、研究或文档项目；内部项目导览。
该技能会从代码和权威文件中恢复产品用途、受众、包管理器、命令、支持版本、配置、示例、仓库策略和许可证等信息，仅询问仓库无法确定的缺失意图。
使用方式
审计准确性
对照清单文件、源代码、CI、示例、配置和许可证文件，检查 README 中的每一项实质性声明。优先处理会导致安装失败、不安全操作、错误 API 使用、安全误解或法律歧义的缺陷。
每项发现需报告：严重程度、章节或行号、声明或遗漏、仓库证据、读者影响、建议修复、验证方式。
不应让数字评分掩盖发布阻断性缺陷。如果用户要求评分，应针对读者任务对相关维度评分并解释权重。
设计信息路径
根据读者需求选择章节，而非固定模板。大多数公共软件 README 需要以下某种形式：身份和简明用途；面向对象和解决的问题；先决条件和安装；最小成功使用及预期结果；重要能力、约束或兼容性；配置和操作要求；深入文档链接；开发、贡献、支持、安全和许可证信息（如相关）。
内部服务可能强调归属、依赖、本地设置、常见操作和运行手册。Monorepo 可能需要在安装前提供包映射。研究或数据仓库可能需要方法论、来源、引用和可复现性，而非徽章或营销视觉。
将首次成功路径放在前面。当 README 变得难以导航时，将参考资料放在专用文档中，但不要将先决条件或关键警告隐藏在链接后面。
基于已验证行为编写
开头应让目标读者无需依赖口号即可识别项目及其用途。当准确性需要限定词时，不要强制任意字数。
安装命令必须匹配仓库的包管理器、支持的运行时、工作区布局和环境需求。展示代表真实 API 或产品的最简单可用方式，并附可观察结果。
仅在功能列表有助于选择时使用。命名能力和相关结果，不编造性能、流行度或客户证明。
不要将徽章、横幅、截图或 GIF 作为强制要素：仅为维护中且有意义的端点添加状态徽章；当视觉材料能实质性澄清 UI、CLI 结果、架构或工作流时添加；使用现有品牌资产和仓库惯例；不要为提升审计评分而创建装饰性媒体或嘈杂的徽章行。
描述仓库的实际许可证并链接到其文件。当不存在许可证时，报告实际歧义，但不提供绝对法律建议。
安全处理命令和示例
将命令分类为已执行、部分验证、仅文档记录或不可用。在可行且安全时，优先在干净的临时环境中验证安装/快速开始。不要发布本地捕获的机密、个人路径或环境值。
在项目允许的情况下编译、类型检查或运行示例。如果示例是说明性的而非可执行的，请标注并保持与当前 API 一致。
输出契约
在生成或修复模式下，交付更新后的 README.md 和简短报告，包含：主要受众和读者任务；使用的权威来源；实际执行的命令和示例；添加、删除或有意省略的章节；检查的链接、资产、徽章和许可证状态；仍未验证的限制或设置路径。
在审计模式下，交付按优先级排列的发现和针对最重要缺陷的建议替换内容。不要仅重写评分最低的外观章节。
验证
按顺序以目标受众新成员的身份阅读 README，确认首次使用路径可发现。
对照仓库证据检查项目名称、包名称、版本、路径、环境变量、端口和预期输出。
在可行时于干净环境中运行安装和最小使用路径；标注任何未执行的内容。
在可用时使用项目的编译器、解释器、linter 或 doctest 路径验证代码块。
使用可用工具检查相对链接、锚点、引用文件、图像、徽章端点和外部文档链接。
确认先决条件、破坏性操作、迁移、安全敏感配置和已知约束在使用点可见。
确认贡献和测试命令与 CI 和仓库脚本匹配。
确认许可证措辞与仓库许可证文件匹配，或明确报告其缺失。
移除占位符、编造的声明、过时的截图和不服务于已识别读者任务的章节。
报告使用的环境和检查，以便“就绪”不意味着未执行的验证。
适用场景
适用于需要审计、编写或验证 README 文件的场景，包括：仓库文档缺失、不准确或需要重写；需要为库、SDK、CLI、托管应用、服务、monorepo、标准/数据集/研究/文档项目或内部项目创建或改进 README；需要确保 README 的准确性、首次使用成功和读者导向。
限制
该技能强调不编造功能、性能、流行度或客户证明；不将徽章、横幅、截图或 GIF 作为强制要素；不发布机密、个人路径或环境值；不提供绝对法律建议。当仓库无法确定某些意图时，仅询问缺失意图。部分命令和示例可能无法在本地验证，需明确标注。