↑
免责声明：本站部分 Skill 来源于公开渠道，使用前请注意识别相关风险，内容版权归原作者所有，如 Skill 涉及版权问题，请在线反馈，核实后予以下架处理。
概述
面向需要为软件仓库撰写或重写根目录说明文档的开发者。本技能通过解析 package.json / pyproject.toml / go.mod 等清单文件、扫描 src / app / cmd 等真实目录结构，以及提取已有文档中的可用信息，按固定一级标题顺序生成可直接提交到版本控制的 README.md。产出包含项目介绍、核心功能模块速览表、技术架构、带行尾注释的目录树、安装步骤与真实命令、使用说明、系统要求及技术亮点等章节；无材料支撑的内容会标注「待补充」或整节省略，杜绝虚构模块名、端口或商业数据。
技能包含
技能包根目录 /├── SKILL.md # （本文件）技能主说明：触发条件、固定章节骨架与自检流程└── references/ # 参考资料与细则 ├── examples.md # 缩略正反例：合格与不合格的 README 片段对照 └── template.md # 完整模版与字段说明：各级标题格式、表格列、树形注释规范
核心能力
- 仓库信息抽取：自动解析清单文件与目录结构，提取名称、依赖、入口、脚本等元信息
- 固定骨架生成：按既定 10 大一级标题顺序输出，确保文档结构统一、可维护
- 事实校验约束：禁止编造未出现的模块、端口、命令；缺省内容标注「待补充」而非虚构填充
- 目录树注释：生成 ASCII 目录树并在行尾以
#标注用途，只反映真实路径 - 多技术栈适配：兼容 Node.js / Python / Go / Rust / Java 等主流项目类型
应用场景
| 用户怎么说 | 本技能做什么 |
|---|---|
| "帮我生成这个项目的 README" | 扫描仓库材料，按固定骨架输出完整 Markdown 文档 |
| "按某某 README 的格式重写我们的说明" | 套用统一章节结构，替换为当前项目的真实信息 |
| "补一下安装教程和目录结构" | 提取 package.json scripts 与真实目录，生成带命令的步骤与注释树 |
| "更新根 README，别瞎编端口和模块" | 仅使用已有材料中的事实，无来源的内容留空或标注待补充 |