liang-senbei/curating-readme

curating-readme 是什么？

该技能允许 AI 代理（例如 Claude Code、Codex）审计一个软件仓库的实际情况，然后将其 README 和相关文档重写为标准化且真实的格式。其核心原则是“基于仓库，杜绝虚构”，这意味着所有生成的内容都必须严格来源于仓库中的实际代码、文件结构和元数据，而不是依赖 AI 的预训练知识或进行猜测。支持与 Git 仓库配合使用的平台。该技能通过首先扫描仓库结构、分析代码、识别关键文件（如 package.json、配置文件、测试文件），然后根据这些发现将 README 重组为包含项目名称、描述、安装指南、使用说明、API 参考和贡献指南等部分的标准化模板来工作。它涉及读取、分析然后重写文档，确保每次更新都准确反映当前仓库的状态。