project-map-builder
Installation
SKILL.md
项目目录地图构建器
为指定目录范围生成或增量更新高信噪比的目录说明文档。
核心规则
- 必须让用户指定要扫描的文件夹范围,禁止默认全仓库扫描。
- 若范围过大,提醒上下文风险并让用户确认或缩小范围。
- 输出语言必须与用户当前语言一致。
- 文档文件名固定:PROJECT_MAP.md。
- 若输出位置已存在 PROJECT_MAP.md,进入更新模式(仅增量更新)。
- 若不存在,进入主动引导模式(先确认范围再新建)。
输出位置规则
- 单目录:将 PROJECT_MAP.md 写在该目录根。
- 多目录:
- 先询问:生成一个合并文档,还是每个目录各生成一个。
- 合并:写到项目根目录。
- 分开:各目录根各写一份 PROJECT_MAP.md。
最少需要询问用户的问题
- 要扫描哪些文件夹?
- 如果是多个文件夹:合并成一个文档,还是分别生成多个?
- 若范围大或不明确:是否确认范围?
工作流
A) 主动引导模式(不存在 PROJECT_MAP.md)
- 确认扫描范围与输出策略。
- 快速列出指定目录的文件清单。
- 识别入口与关键文件(如 manifest、主入口、服务线程、UI、配置、存储、测试、文档)。
- 只打开“关键文件”用于解释职责与关系,避免全量读取。
- 按结构模板生成 PROJECT_MAP.md。
- 不确定处必须显式标注(如“假设”“未确认”)。
B) 更新模式(已存在 PROJECT_MAP.md)
- 读取既有 PROJECT_MAP.md。
- 仅重新扫描用户指定的目录范围。
- 结合“当前对话上下文”与文件清单差异,定位需更新的段落。
- 只做增量补丁更新,不进行全量重写。
- 添加“本次更新”小节(日期 + 范围 + 变更点)。
扫描规则
- 优先使用快速文件列表命令(如
rg --files或Get-ChildItem)。 - 不要打开所有文件,只读关键文件。
- 如需更深入的细节,先向用户确认要深入的子目录。
文档结构模板(PROJECT_MAP.md)
可按需调整,但建议包含:
- 项目概览(一句话)
- 作用范围(本次扫描的文件夹列表)
- 入口与运行链路(简化版)
- 关键配置与存储键(如适用)
- 目录与文件说明(按目录层级)
- 关键模块关系/调用链
- 风险/遗留/不确定点
- 本次更新(仅更新模式)
多目录输出规则
- 合并文档:在“作用范围”列出每个目录,并为每个目录写独立小节。
- 分开文档:每个目录只描述自身范围,不做跨目录合并。
更新模式规则(仅增量)
- 尽量保留已有结构与表述。
- 只修改与新增/删除文件或新上下文相关的部分。
- 除非明确错误,否则不删除旧内容。
- “本次更新”记录日期、范围与变更摘要。
安全与清晰性
- 无法确认的行为或规则必须标注为“假设/未确认”。
- 看似遗留的文件应标注为“可能遗留”,除非用户要求,否则不建议删除。
Related skills
More from yunshu0909/yunshu_skillshub
github-repo-search
帮助用户搜索和筛选 GitHub 开源项目,输出结构化推荐报告。当用户说"帮我找开源项目"、"搜一下GitHub上有什么"、"找找XX方向的仓库"、"开源项目推荐"、"github搜索"、"/github-search"时触发。
248weekly-report
帮助用户梳理周报,按照完整逻辑展示工作价值和边界。当用户说"写周报"、"周报"、"梳理周报"、"整理工作"时触发。
166writing-assistant
写作助手 - 当用户说"我想写XX"、"帮我梳理选题"、"怎么形成框架"、"给我组织思路"时触发。根据观点清晰度自动选择最优路线:清晰观点走"框架→内容",模糊观点走"挖掘→选题→框架→内容"。
140lesson-builder
帮助用户通过讨论完成课程大纲和课件。当用户说"备课"、"做课件"、"准备课程"时触发。
110prd-doc-writer
Write and iteratively refine PRD/需求文档 with a story-driven structure and strict staged confirmations (journey map alignment, per-story single-point confirmation, final generation gate). Use when the user asks to 梳理/撰写/完善 PRD、需求文档、用户故事、验收标准,并希望用 ASCII 线框图与 Mermaid(流程图/状态图/时序图)来减少歧义、共同完成文档。
103thinking-partner
思考拍档 - 陪你从混沌中理清局面,锁定核心问题,拆解卡点,共创解法,落地行动
83