代码库文档化
接手别人的 GitHub 仓库却缺少文档时用这条：让它加载指定仓库，梳理架构、模块关系与核心类函数，画出依赖关系图，输出架构文档、Mermaid 流程图和每个接口的调用示例。
适合做什么
- 在 Cursor / 同类 Agent 里挂载可复用技能
- 把重复检查或生成流程固化成一句话指令
- 团队共享「技能卡」减少口头约定
不太适合
- 当作完整安全审计或生产发布的唯一依据
- 无环境上下文时指望一次跑通复杂流水线
提示词正文
【技能名称】代码库文档化
【技能目标】克隆/加载指定GitHub仓库，分析架构、模块关系、核心类/函数、依赖图，输出完整架构文档+Mermaid流程图+每个API的使用示例。
【使用方式】
1. 将上方目标作为 Agent Skill / 自定义指令的核心描述；
2. 补充你的项目路径、技术栈与验收标准；
3. 要求 Agent 先列出检查清单，再执行并给出可复核的输出（如 diff / 报告）；
4. 若涉及发布或删除，必须二次确认。
【运营向用法提示】
可用于内容站、工具站或增长落地页的自动化检查与批处理；输出请要求中文结论 + 可执行下一步。复制后粘贴到 AI 对话框，按填空补全即可。
使用步骤
- 先确定要文档化的仓库地址和关注的模块
- 把技能目标粘进Agent，说明技术栈与输出文档路径
- 先让它出检查清单和模块列表，再核对流程图
常见问题
仓库很大跑不动怎么办？
先限定到某个子目录或几个核心模块，让它分批分析，每批产出后再合并。一次性喂整个仓库容易丢细节，也会让模块关系图变得看不清。
私有仓库能直接读取吗？
要看运行环境是否能访问该仓库。公开仓库通常可直接拉取，私有仓库往往要先在本地克隆好再把路径给它，权限和密钥由你自己配置。
生成的架构文档准不准？
它基于代码结构和命名推断，业务意图、历史包袱这类信息文档里没有。涉及核心链路的描述要对着源码抽查几处，必要时把团队约定补进指令。
来源说明
整理自公开提示词站点素材，经 52运营 筛选与页面改写，便于运营场景检索。 原始参考：来源链接