SuperAPI AI 工具集

project-wiki

编程与开发

查看项目

更新于 10-15 21:50

技能介绍

用途:为 Vibe Coding 项目(人类描述意图、Agent 写代码)生成与维护结构化 wiki。wiki 是 Agent 的输入物料,直接影响输出质量。触发场景包括初始化/重构 wiki 结构、进入新项目且 wiki/ 不存在、诊断并修复文档腐化、管理 specs/refs/reviews 子目录生命周期。

主要能力: 初始化:扫描 wiki/,对照必要文件清单识别缺失项,与用户确认后从 assets/ 模板生成骨架,更新 01-project-roadmap.md 导航,为文件加 <!-- Last verified: YYYY-MM-DD | Current stage: X --> 标记,并将维护规则追加到项目 CLAUDE.md(不替换整个文件)。 重构/更新:检查编号方案与新鲜度标记;诊断缺编号、信息重叠、未归档 stage、内容与代码不一致;做膨胀检测(stage >300 行、其他 >500 行建议拆分);识别散落文件、命名不一致与自定义子目录;生成改动清单并确认后执行,最后验证引用链接与 roadmap 索引。 文件体系:分紧凑方案(≤5 个 stage,0x 统一放战略+架构)与展开方案(>5 个 stage 或需更多分层,0x 战略 / 2x 架构 / 3x 接口 / 4x 规范 / 6x 阶段 / 8x 运维 / 9x 日志)。两种方案内容与模板相同,仅编号前缀不同,项目内须保持一致。 核心模型:Why/What/How/Look × 全局/阶段;stage 文件同时承载 What 与 How,全局文件只做索引导航。 规划层级:roadmap(01)管月/季度方向与里程碑,backlog(85)管周/迭代具体任务;发版时从 backlog 已完成条目整理进 changelog(90)。 子目录:specs/(spec-{feature}.md,位置即状态,完成后 git mv 到 archive/specs/);refs/(外部知识内部镜像,被 2+ 文件重复引用时创建);reviews/(review-{YYYY-MM-DD}-{subject}.md,action items 完成后归档);archive/(specs/reviews/stages,只追加查阅不删除)。 渐进式披露:第一层始终读 00-product-proposal 与 01-project-roadmap;第二层按任务类型加载结构文件(新功能/修 Bug/UI 调整/调研/评审各有路径);第三层仅在出现“→ 详见”链接时钻取,不主动扫描子目录。 腐化检测:断链检测(grep -rn 相对引用)、新鲜度(超 30 天标 May be outdated)、孤立文件、重复信息、膨胀、散落文件、命名迁移,最后输出汇总表与优先级建议。 关联管理:引用用相对路径+锚点;修改文件后 grep -r 查引用方是否需同步;重命名/移动需全文搜索旧路径;重命名/归档等高频联动有 checklist。 编写规范:结构化(表格>段落、代码块>描述、类型定义>自然语言);只维护一份权威源;记决策不记细节;追求信息密度,删到再删就丢信息为止。 模板:位于 assets/,涵盖 product-proposal、project-roadmap、business-model、technical-pillars、system-architecture、design-principle、api-reference、conventions、stage-x、known-pitfalls、postmortem、design-exploration、backlog、changelog、spec、ref、review。 限制:未提供具体收费、平台支持、版本要求或依赖安装步骤。维护规则写入 CLAUDE.md 时需按项目实际存在的 wiki 文件裁剪,只保留已创建文件对应行;无需每次 commit 都更新,在功能完成、API 变更、架构调整等节点同步即可。