README生成器
项目想补一份 README 时用这条：让 Agent 读取项目结构，它会生成项目特性展示、快速安装说明、五分钟上手示例、接口文档、贡献指南、许可协议和徽章配置等章节。
适合做什么
- 在 Cursor / 同类 Agent 里挂载可复用技能
- 把重复检查或生成流程固化成一句话指令
- 团队共享「技能卡」减少口头约定
不太适合
- 当作完整安全审计或生产发布的唯一依据
- 无环境上下文时指望一次跑通复杂流水线
提示词正文
【技能名称】README生成器
【技能目标】根据项目结构自动生成完整README：项目特性展示、快速安装、5分钟上手示例、API文档、贡献指南、License、徽章配置。
【使用方式】
1. 将上方目标作为 Agent Skill / 自定义指令的核心描述；
2. 补充你的项目路径、技术栈与验收标准；
3. 要求 Agent 先列出检查清单，再执行并给出可复核的输出（如 diff / 报告）；
4. 若涉及发布或删除，必须二次确认。
【运营向用法提示】
可用于内容站、工具站或增长落地页的自动化检查与批处理；输出请要求中文结论 + 可执行下一步。复制后粘贴到 AI 对话框，按填空补全即可。
使用步骤
- 把项目目录结构和技术栈粘进技能描述
- 补充安装命令、环境变量和上手示例
- 先出大纲核对，再生成正文和徽章配置
常见问题
没有License文件能写吗？
可以让它先留出License章节占位，并提示你补上协议名称与年份；具体授权条款需要你按项目实际情况填写，模型不会替你选定协议。
徽章配置需要自己补什么？
把仓库地址、包名、CI或构建服务的标识写进技能描述，徽章链接才能拼对；不确定的服务可以先留空，避免生成失效链接。
适合直接替换原README吗？
先保留原文备份，对照大纲逐节核对功能描述和安装命令是否与实际一致，把过时或与当前版本不符的段落删掉再合并。
来源说明
整理自公开提示词站点素材，经 52运营 筛选与页面改写，便于运营场景检索。 原始参考：来源链接