关于 readme
readme 是一项指导 Agent 审计、修复或生成 README 的技能，面向需要依据仓库实际行为编写文档的开发者。它强调逐项核验事实、呈现可验证的首次使用路径，并按模式提供相应交付内容。
主要功能
- 01支持审计、修复和生成模式
- 02按读者任务组织文档
- 03对照仓库证据核验声明
- 04检查安装与示例命令
- 05提供各模式的输出要求
- 06验证链接、代码块和许可信息
适用场景
- 01检查 README 中过时或不准确的说明
- 02为新仓库生成首次使用指南
- 03修复安装步骤和代码示例
- 04审核文档中的安全或许可遗漏
安装
复制下面的命令，在终端中运行。
npx skills add https:/安装后在 Claude Code 中输入/readme确认已加载。
详细介绍
README
根据仓库的实际行为，编写真正符合 README 读者需求的内容。准确性和顺利完成首次使用，优先于宣传内容的完整性。
选择模式并明确读者任务
- 审查 — 报告准确性、覆盖范围和易用性方面的问题；仅在用户要求时编辑。
- 修复 — 更新具体的薄弱或过时部分。
- 生成 — 在不存在 README 或用户明确要求重写时，创建 README。
识别仓库类型和读者的主要任务：
- 采用库或 SDK；
- 安装 CLI 并运行第一条命令；
- 设置托管应用或参与贡献；
- 运行服务和进行本地开发；
- 浏览单体仓库并了解各包的归属；
- 标准、数据集、研究或文档项目；
- 内部项目概览。
从代码和权威文件中确认产品用途、受众、包管理器、命令、支持的版本、配置、示例、仓库政策和许可证。仅针对无法从仓库中确认的缺失信息提问。
优先审查准确性
对照清单、源代码、CI、示例、配置和许可证文件，核实 README 中的每项重要声明。优先处理可能导致安装失败、操作不安全、API 使用错误、安全理解偏差或法律含义不明确的问题。
对每项发现，报告：
[severity] [section or line]
Claim or omission:
Repository evidence:
Reader impact:
Recommended repair:
Verification:
不要让数值评分掩盖会阻碍发布的问题。如果用户要求评分，应根据读者任务选择合适的评分维度，并说明权重。
设计信息路径
根据读者需求选择章节，而不是套用固定模板。大多数面向公众的软件 README 都需要包含以下部分中的某种形式：
- 项目名称和简明用途；
- 适用对象及其要解决的问题；
- 前置条件和安装方法；
- 最简可用示例及预期结果；
- 重要功能、限制或兼容性；
- 配置和运行要求；
- 更深入文档的链接；
- 相关的开发、贡献、支持、安全和许可证信息。
内部服务可以重点介绍负责人、依赖项、本地设置、常见操作和运行手册。单体仓库可能需要在安装说明前提供包概览。研究或数据仓库可能需要介绍方法、来源、引用和可复现性，而不是徽章或营销图片。
将首次成功使用的路径放在靠前位置。如果参考资料会让 README 更难浏览，就将其放在专门的文档中；但不要通过链接隐藏前置条件或关键警告。
根据已验证的行为撰写
开篇应让目标读者无需依赖口号，就能了解项目及其用途。为保证准确性需要加上限定说明时，不要强行限定字数。
安装命令必须符合仓库的包管理器、支持的运行时、工作区布局和环境要求。展示能体现真实 API 或产品的最简单可用示例，并说明可观察到的结果。
仅在有助于读者选择时列出功能。说明具体能力及相关效果，不要捏造性能、知名度或客户背书。
不要将徽章、横幅、截图或 GIF 作为必备内容：
- 仅为持续维护且有意义的端点添加状态徽章；
- 仅在视觉内容能显著说明界面、CLI 结果、架构或工作流时添加；
- 使用现有品牌资源并遵循仓库惯例；
- 不要为了提高审查评分而制作装饰性媒体或堆砌徽章。
说明仓库的实际许可证，并链接到许可证文件。如果没有许可证，应说明由此带来的实际不明确之处，但不要给出绝对化的法律建议。
安全处理命令和示例
将命令分类为已执行、部分验证、仅有文档说明或不可用。条件允许且安全时，优先使用干净的临时环境验证安装和快速入门。不要公开本地捕获的机密、个人路径或环境值。
如果项目条件允许，请编译、进行类型检查或运行示例。如果示例仅作说明而无法执行，请明确标注，并确保其与当前 API 一致。
输出约定
在生成或修复模式下，交付更新后的 README.md 和一份简短报告，内容包括：
- 主要受众及读者要完成的任务；
- 使用的权威来源；
- 实际执行过的命令和示例；
- 新增、删除或有意省略的章节；
- 已检查的链接、资源、徽章和许可证状态；
- 尚未验证的限制或设置路径。
在审计模式下，交付按优先级排序的问题，以及针对最重要缺陷的建议替换内容。不要只重写得分最低的表面内容。
验证
- 按顺序阅读 README，设想自己是目标受众中的新成员，并确认首次使用的路径清晰可见。
- 根据仓库证据检查项目名称、软件包名称、版本、路径、环境变量、端口和预期输出。
- 条件允许时，在干净环境中运行安装和最简使用流程；注明未执行的内容。
- 在有可用工具时，使用项目的编译器、解释器、linter 或 doctest 流程验证代码块。
- 使用可用工具检查相对链接、锚点、引用文件、图片、徽章端点和外部文档链接。
- 确认前置条件、破坏性操作、迁移、安全敏感配置和已知限制均在相关位置清晰说明。
- 确认贡献和测试命令与 CI 及仓库脚本一致。
- 确认许可证措辞与仓库中的许可证文件一致，或明确报告该文件缺失。
- 删除占位内容、杜撰的声明、过时的截图，以及与已确定的读者任务无关的章节。
- 报告所用环境和执行过的检查，避免让“已就绪”暗示实际上未执行的验证。