update-readme
自动分析仓库上下文，智能重构README
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：update-readme。 它的用途是：自动分析仓库上下文，智能重构README 完整的 Skill 内容见：https://321skill.com/skills/update-readme-x-3/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“更新当前项目README，重点突出安装步骤和API使用示例。”它会先扫描项目中的package.json、目录结构、代码注释，然后生成一个包含快速开始、API文档、常见问题等模块的README.md文件，最后自动替换原文件。
介绍
解决什么问题：维护项目README时，开发者常面临结构混乱、内容陈旧、缺乏吸引力等问题。手动更新耗时长且容易忽略关键信息。本Skill通过分析仓库代码结构、依赖关系、文档注释等上下文，并结合优秀开源项目的README范例，自动生成或重构README，确保其结构清晰、内容完整、符合最佳实践。
怎么用：在支持该Skill的AI编码工具中，直接对AI说“更新当前仓库的README”，或指定特定仓库路径。AI会先扫描仓库内容，分析项目类型、技术栈、目录结构、关键文件等，然后基于研究到的优秀README模板，生成包含项目简介、安装说明、使用示例、API文档、贡献指南、许可证等模块的markdown文件。用户可进一步调整细节。
适合谁：需要频繁维护开源项目或团队内部分享文档的开发者、技术文档工程师、项目经理。尤其适合那些希望快速让README专业化、标准化，但又不想手动逐项编写的场景。
使用建议：生成后建议人工审核，特别是涉及敏感信息或定制化描述的部分。对于已有大量自定义内容的README，建议先备份再使用本Skill进行重构，避免覆盖重要信息。
核心特点
本Skill不只是简单填充模板，而是通过分析仓库实际代码和上下文，自动提取关键信息（如依赖、目录结构、API入口），并参考同类优秀项目的README结构，生成更贴合项目实际情况的文档，而非通用模板。
注意事项
不适合需要完全人工撰写创意性前言或品牌故事等高度定制化内容的场景，且无法处理非代码仓库（如纯文档项目）。
常见问题
这个Skill能保留我原有的README内容吗？
它会基于现有内容进行重构，但建议提前备份，以免覆盖自定义部分。
需要联网吗？
需要连接网络以获取优秀README范例研究，但仓库分析可在本地完成。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/update-readme-x-3/raw/index.md 读取 update-readme 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/update-readme-x-3/raw/index.md（查看排版版本）