SuperAPI AI 工具集

project-wiki

编程与开发

查看项目

更新于 10-16 03:42

技能介绍

用途:根据现有代码仓库递归分析项目结构、代码结构与内容,生成 DeepWiki 风格的完整项目文档。

主要能力:自动检测运行模式。先检查 .gitmodules,存在则执行 git submodule update --init --recursive --depth 1;项目为空时进入新项目规划模式(交互式问答收集需求后生成文档);存在 {{workspace}}/.monkeycode/docs/ARCHITECTURE.md 时进入同步/刷新模式,检测变更并增量更新;否则为完整生成模式,分析仓库、创建文档结构并填充内容。完成后执行 git commit、git push,并向用户确认、收集反馈。

输出结构:{{workspace}}/.monkeycode/docs/ 下生成 INDEX.md、ARCHITECTURE.md、INTERFACES.md、DEVELOPER_GUIDE.md,以及“专有概念/”核心概念页面和“模块/”模块 README。

使用方式:通过触发关键词区分模式,如“新项目”“从零开始”“规划项目”对应新项目规划;“同步文档”“更新文档”“刷新wiki”对应同步/刷新;“生成文档”“创建文档”“构建wiki”对应完整生成。除新项目规划外,任务在不与用户交互的前提下完成。若 workspace 下存在多个子项目,文档统一输出到 {{workspace}}/.monkeycode/docs/。

限制:源代码只读,可分析任何文件但绝不修改源码,只能创建或更新 Markdown 文档;文档必须严格基于实际代码、配置和测试,不得编造不存在的功能、API 或行为,无法确定时写“无法确定”;不得包含 API 密钥、密码、令牌或凭证,示例使用 <API_KEY> 等占位符。文档模板参考 templates.md。具体安装命令、收费与平台信息暂未提供。