update-readme

介绍

维护项目README文档往往需要耗费大量精力，新手常因缺乏经验而写出结构混乱、内容缺失的文档，老手也容易因项目迭代而忘记同步更新。这个Skill能自动读取你的仓库代码、文件结构、依赖关系等上下文信息，并结合数千个优秀的开源项目README范例，为你生成或更新一份结构清晰、内容完整的README文档。

使用时，只需在AI编码助手中输入“更新README”或“根据当前项目生成README”，它会自动分析仓库中的所有关键信息（如项目名称、功能描述、安装方式、API文档、贡献指南等），然后按照行业最佳实践组织成标准结构，包括项目简介、快速开始、使用示例、配置说明、API参考、贡献指南等模块。支持增量更新，只修改需要变化的部分。

适合所有需要维护GitHub/GitLab项目README的开发人员，尤其是开源项目维护者、团队协作中的项目负责人、以及希望提升项目专业度的个人开发者。后端开发、全栈开发、文档工程师都能从中受益。

建议在项目初始化时或每次重大版本迭代后使用该Skill，以确保README始终与代码同步。对于已有README的项目，它会保留你手动编写的核心内容，只补充缺失的模块和优化结构，不会覆盖你精心设计的个性化部分。注意：对于极简的个人玩具项目，可能不需要完整的README结构，可以手动指定仅生成特定模块。