SuperAPI AI 工具集

wiki-architect

写作与研究

查看项目

更新于 10-15 21:47

技能介绍

用途:Wiki Architect 从代码仓库生成结构化 wiki 目录和入门指南。当用户提出“创建 wiki”“为这个仓库写文档”“生成文档”、想理解项目结构或架构、需要目录/文档计划,或索取上手引导与“zero to hero”路径时启用。

必要前置:先解析来源仓库。运行 git remote get-url origin 检查是否存在远程仓库,并向用户确认是仅本地仓库还是有来源仓库 URL(如 GitHub、Azure DevOps)。有远程 URL 时存为 REPO_URL,用链接引用 file:line;仅本地则用 (file_path:line_number)。再运行 git rev-parse --abbrev-ref HEAD 确定默认分支。未解析来源上下文前不得继续。

主要能力:扫描仓库文件树与 README,识别项目类型、语言、框架、架构模式与关键技术,划分表现层、业务逻辑、数据访问、基础设施等层次,生成含 items[].children[]、每节点有 title、name、prompt、children 字段的分层 JSON 目录。目录含 Onboarding(始终置顶、不折叠):Contributor Guide(分语言/框架基础、本仓库架构与领域模型、开发环境/测试/导航/贡献三部分,附 40+ 术语表和关键文件参考)、Staff Engineer Guide(核心架构洞见及另一种语言伪代码、Mermaid 架构图、领域模型 ER 图、设计权衡、决策日志、依赖理由、深入阅读顺序)、Executive Guide(能力图、风险评估、技术投资论点、成本/扩展模型、依赖图、建议,无代码片段)、Product Manager Guide(用户旅程、功能能力图、已知限制、数据/隐私、配置/功能开关、FAQ,不含工程术语);Getting Started(概览、安装、用法、快速参考);Deep Dive(架构→子系统→组件→方法)。每节提示须引用真实文件。

语言检测:按扩展名与构建文件判断主语言并选对比语言:C#/Java/Go/TypeScript 对 Python,Python 对 JavaScript,Rust 对 C++ 或 Go。

限制:最大嵌套 4 层,每节最多 8 个子项;≤10 个文件的小仓库仅生成 Getting Started(跳过 Deep Dive,仍含 onboarding);所有标题须源自实际仓库内容,不用通用占位符。输出为符合目录 schema 的 JSON 代码块。