SuperAPI AI 工具集

wiki-onboarding

通用与其它

查看项目

更新于 10-15 21:47

技能介绍

用途:为代码仓库生成四份面向不同受众的新手引导文档,统一放入 onboarding/ 文件夹,使不同利益相关者各取所需,快速理解项目。主要能力:产出 index.md(引导中心,含项目摘要与选文表格)及 contributor-guide.md、staff-engineer-guide.md、executive-guide.md、product-manager-guide.md 四份指南,分别面向新贡献者、staff/principal 工程师、VP/总监级工程领导者和产品经理。使用方式:先解析源仓库上下文——运行 git remote get-url origin 判断是否存在远程,询问用户是本地仓库还是提供源仓库 URL(如 GitHub、Azure DevOps),再运行 git rev-parse --abbrev-ref HEAD 确定默认分支;未解析源仓库前不得继续。远程时使用链接式引用 file:line,仅本地时使用 (file_path:line_number)。触发条件:用户要求引导或入门文档、运行 /deep-wiki:onboard 命令、或希望帮助新成员理解代码库。会扫描仓库构建文件判断主语言(如 package.json/tsconfig.json 为 TypeScript/JavaScript、Cargo.toml 为 Rust、pyproject.toml/setup.py/requirements.txt 为 Python、go.mod 为 Go 等)。限制:资料仅规定上述流程与文档结构,未提供收费、价格、平台、效果等事实;生成后需校验文件路径真实存在、类与方法名准确、Mermaid 可渲染、通用类型标签置于反引号内,且面向高管的指南不得含代码片段。