Agent skill · wuchubuzai2018
haizei-project-wiki-generator
生成项目 Wiki技能、技术 Wiki、业务 Wiki生成技能。用户提到"生成 wiki"、继续生成 wiki""刷新 wiki""补齐 docs 文档结构"时务必使用。适用于深度分析用户指定的项目或模块,先规划系统性 wiki 目录、经用户确认后再通过子代理逐篇生成高质量技术与业务文档。不适用于:纯 API 文档生成(用 TypeDoc/Swagger)、README 编写、代码注释生成、非代码项目的文档、已有完善文档只需格式转换的场景。
What it needs
About 4k tokens when loaded.
What this skill does
Project Wiki Generator 深度分析项目代码,生成系统性的技术 Wiki 与业务 Wiki,以 VitePress 文档站交付。 技能定位 这是一个代码分析驱动的 wiki 生成技能,核心价值是: 1. 深度阅读项目源码,追踪调用链、识别模块边界、提取业务规则 2. 产出结构化的技术分析文档(01-07 系列)和业务域文档 3. 每篇文档由独立子代理生成,确保分析深度和质量 4. 以 VitePress 文档站作为交付格式,支持本地预览和团队共享 工作原则 分析为主线:先深度理解代码,再产出文档。不是先搭站点再填内容。 事实为基:严格只写能从代码/配置/已有文档中确认的内容。推断项标为"待确认"。 来源可追溯:每个关键结论绑定至少一个代码来源(类、方法、配置、表)。 用户确认门控:目录规划必须经用户确认后才开始生成正文。 子代理保质量:每篇文档由独立子代理生成,避免上下文稀释导致质量下降。 增量优先:已有文档优先局部补写,不默认整篇重写。 参考文件路由表 文件 作用 调用时机 ------ ------ ---------- references/tech-prompts.md 技术 Wiki 01-07 每篇的写作规则与必含区块 Phase 4 生成技术文档时必须参考 references/biz-prompts.md 业务 Wiki 域文档的写作规则 Phase 4 生成业务文档时必须参考 references/agent-prompts.md 子代理 prompt 模板(含通用前缀) Phase 4 构造子代理指令时必须参考 references/vitepress-template.md VitePress 首页、config.mts 模板 Phase 1 初始化时必须参考 references/output-structure.md 输出目录结构规范 Phase 3 规划目录时必须参考 references/edit-checklist.md 增量修订检查清单 修改已有文档时必须参考 references/known-gotchas.md 已知陷阱与规避(❌/✅ 对比) Phase 4 子代理 prompt 中必须附带 --- Phase 1: 范围确定与环境初始化 1.1 识别用户意图 必须先判断用户属于哪种诉求: 1. 首次生成:项目没有 wiki,需要完整流程(分析 → 规划 → 确认 → 生成) 2. 继续生成:已有部分 wiki,用户说"继续生成 wiki / tech wiki / biz wiki" 3. 增量刷新:已有文档需要补章节、修正、刷新导航 4. 质量检查:用户要求检查当前 wiki 质量 1.2 确定分析目标 默认分析当前工作目录 如果用户指定了路径(如"分析 D:/projects/my-app"),使用指定路径 输出始终在当前工作目录的 docs/ 1.3 智能初始化 VitePress 检查 docs/ 是否存在: 不存在 → 运行 node scripts/init-vitepress.mjs <project-root> 初始化 存在但无 .vitepress/config.mts → 补充 VitePress 配置 存在且有配置 → 检查是否为本技能管理(含 // project-wiki-generator managed config 注释),准备增量更新 输出提示:[Phase 1 完成] 模式:<首次生成 继续生成 增量刷新>,分析目标:<路径> --- Phase 2: 深度项目分析 这是技能的核心 — 由 Claude 自身执行深度代码分析。 2.1 分析动作清单 按以下顺序执行分析(使用 Glob、Grep、Read 等工具): 1. 技术栈识别:构建工具、框架、语言、依赖管理 2. 入口点识别:启动类、Controller、Job、消息入口、外部回调 3. 模块划分:目录结构、包职责、模块边界 4. 核心类与继承关系:抽象类/接口的关键实现(至少展开 1-3 个) 5. 调用链追踪:主链路方法追踪 3 层深度,标注关键分支和状态变化 6. 数据模型:实体类、数据库表、字段含义、对象关系 7. 外部依赖:第三方服务、中间件、消息队列、缓存 8. 业务规则提取:if/switch 条件分支、状态机、配置开关 9. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills wuchubuzai2018/haizei-project-wiki-generator