1. 基本信息
| 项目 | 内容 |
|---|---|
| 名称 | folder-structure-blueprint-generator-github-awesome-copilot |
| 作者/维护者 | GitHub 官方组织仓库 github/awesome-copilot(社区贡献者提交,经官方合并收录) |
| 来源链接 | https://github.com/github/awesome-copilot/tree/main/skills/folder-structure-blueprint-generator |
| 许可证 | MIT(GitHub API 数据) |
| GitHub Stars | 39,087(合集仓库整体数据;由 400 余个子技能共享,不代表本技能个体热度) |
| Forks | 4,958(同上,合集整体数据) |
| 最新版本 | 无独立版本号;该文件最近一次改动于 2026-02-19(GitHub API 数据) |
| 安装方式 | 复制 skills/folder-structure-blueprint-generator/SKILL.md 到对应 agent 的 skills 目录;或 npx skills add https://github.com/github/awesome-copilot --skill folder-structure-blueprint-generator |
2. 功能介绍与亮点
技术栈无关的项目目录结构分析与文档生成提示词。给定代码库后:
- 自动检测项目类型(.NET/Java/React/Angular/Python/Node.js/Flutter 等)、是否为 monorepo、是否含微服务、是否含前端组件,也支持手动指定
- 按可配置的可视化风格(ASCII 树 / Markdown 嵌套列表 / 表格)与深度层级生成目录结构图
- 逐目录说明用途、内容类型与组织模式,覆盖分层组织、领域/特性组织、配置管理、测试目录组织等维度
- 记录文件命名规范(大小写风格、前后缀模式)、文件放置模式(配置/模型/业务逻辑/接口/测试文件该放哪)与构建产物组织方式
- 可选生成“新增功能/组件/服务/测试”时应遵循的目录模板,作为团队协作的落地规范
纯 Markdown 提示词驱动,无需安装依赖或配置环境变量,产出物(Project_Folders_Structure_Blueprint.md)可直接沉淀为团队文档。
3. 适用场景
所属分类:工程效率与代码质量(判定依据见下方评分表后的分类说明)。
- 团队新人加入陌生代码库前,快速理解文件该放在哪、为什么这么放
- 技术负责人把已有的隐性目录组织习惯(命名、分层、放置规则)沉淀成显式文档,避免新功能落地时随意摆放文件
- Monorepo 或微服务项目缺乏统一目录规范时,先产出一份基线文档再逐步收敛
4. 跨 Agent 兼容性
| Agent | 结论 | 依据 |
|---|---|---|
| Claude Code | 原生支持 | 标准 SKILL.md(YAML front matter + Markdown 正文),符合开放 Agent Skills 规范,复制进 skills 目录即可加载 |
| Codex | 需适配 | Codex CLI 不会自动扫描 ~/.codex/skills 目录下的 SKILL.md,需要通过 -f 参数或 stdin 显式引用文件内容后才能使用 |
| OpenClaw | 原生支持 | 采用同一开放 Agent Skills 规范,本技能不含平台专属 metadata,可直接放入对应目录加载 |
| Hermes Agent | 原生支持 | Hermes 在其 skills 目录下按同一目录结构自动发现 SKILL.md;本技能零依赖、零环境变量,不构成兼容障碍 |
5. 推荐理由
目录该怎么组织、文件该放哪,是几乎每个工程团队都有隐性共识、却很少写成文档的规范——新人靠观察摸索,规范全凭口口相传,一旦团队扩张或换人就容易走样。本技能把“扫描现状 → 归纳组织原则 → 输出命名与放置规则 → 给出新增模板”固定成一套可配置分析清单,覆盖八种主流技术栈的目录惯例,产出物可直接当团队 onboarding 文档或目录规范基线使用。
6. 评分
| 维度 | 分数 | 说明 |
|---|---|---|
| 受欢迎程度 | 7 | 发布方为 GitHub 官方组织仓库,属该技能市场的官方收录背书;该子技能本身未见独立于合集之外的第三方讨论或采用数据,合集整体星数由 400 余个子技能共享,不能计入本技能个体热度 |
| 可用性 | 8 | 纯 Markdown 提示词,无需安装任何依赖,复制进对应 agent 的 skills 目录即可使用;内置的项目类型/可视化风格/深度层级等配置项均支持自动检测,也可手动指定;文档完整覆盖目录概览到命名规范、文件放置模式、结构模板等十余个维度;最近一次更新为 2026 年 2 月,距今约 7 个月 |
| 安全性 | 9 | 纯提示词/模板类技能,运行时只读取代码库文件用于分析,不执行任何脚本、不发起网络请求、不要求任何凭据或 API Key |
安全检查清单:
| 检查项 | 结果 |
|---|---|
| ① Shell 命令及权限范围 | 无 shell 命令执行,纯提示词分析 |
| ② 运行时联网外发 | 无 |
| ③ API Key/凭据要求 | 不需要 |
| ④ 可疑指令(prompt injection 迹象) | 未发现 |
| ⑤ 作者/组织信誉 | GitHub 官方组织仓库收录 |
| ⑥ License | MIT,明确 |
| ⑦ 最近维护时间 | 2026-02-19,约 7 个月前 |
7. 跟同类 Skills 相比的优势
同一合集仓库内还有若干“技术栈无关的蓝图生成器”系列技能,各自聚焦不同的文档产出物:
| 技能 | 产出物定位 | 与本技能的差异 |
|---|---|---|
| project-workflow-analysis-blueprint-generator | 端到端工作流实现文档 | 追踪具体工作流从入口点到数据层的调用链路,不涉及目录组织与命名规范 |
| architecture-blueprint-generator | 整体架构文档(C4/UML 图、架构决策记录) | 描述系统的宏观架构与设计决策,不落到具体文件该放哪一层 |
| readme-blueprint-generator | 项目 README.md | 面向仓库门面文档,扫描 .github/copilot 生成技术栈/开发流程概览,不涉及目录内部的组织细节 |
| code-exemplars-blueprint-generator | 代码范例清单 | 扫描代码库挑选高质量代码样本作为编码标准参考,关注代码本身而非目录结构 |
差异化在于专注目录层面的组织原则、命名规范与文件放置模式,产出物可直接作为“新文件该放哪、该怎么命名”的操作依据,而非宏观架构说明或工作流调用链文档。
8. 用户评价
该技能目前在第三方平台尚无具名用户评价;检索结果均为技能市场镜像站点对其描述的转载,未见独立于 GitHub 仓库之外的用户讨论。
9. 其他补充
同仓库的 readme-blueprint-generator、architecture-blueprint-generator、code-exemplars-blueprint-generator、project-workflow-analysis-blueprint-generator 属同一批次引入的兄弟技能,各自产出物互不重叠,详见第 7 章对比。
10. 安装使用方式
Claude Code / OpenClaw / Hermes Agent:将 skills/folder-structure-blueprint-generator/SKILL.md 复制到对应 agent 的 skills 目录即可自动加载。
脚手架工具:
npx skills add https://github.com/github/awesome-copilot --skill folder-structure-blueprint-generator
Codex:下载 SKILL.md 后通过 -f 参数或标准输入显式传入。
安装后无需重启,对话中要求 agent 分析当前代码库目录结构即可触发;建议先用默认的“自动检测”配置跑一遍,再按需调整可视化风格与深度层级。
11. 注意事项
- 内置配置变量(如
PROJECT_TYPE、VISUALIZATION_STYLE)需理解其含义才能精确控制输出,多数场景保留默认“自动检测”即可 - 超大型 monorepo 或混合多种技术栈的项目,单次生成的目录蓝图篇幅可能较长,建议按子项目分批调用
- 不修改代码库任何文件,仅在对话中输出文档内容,需自行保存
- 最近更新距今约 7 个月,若上游框架的目录约定发生较大变化(如新版脚手架默认结构调整),文档中的具体技术栈章节可能需人工校对