SuperAPI AI 工具集

codebase-onboarding

测试与质量

查看项目

更新于 10-15 17:28

技能介绍

用途:分析任意代码库,按受众生成生产级上手文档,用于新成员入职、重构后文档更新、开源前准备、团队 wiki、长期休假前自文档化或合规审计准备。

主要能力:架构分析(从清单/锁文件识别技术栈、系统边界、Mermaid 数据流图、依赖图、模块归属);关键文件标注(列出最重要的 20 个文件及原因,标记入口、配置中心、共享工具与需协调修改的危险文件);搭建指南(精确版本前置条件、从 git clone 到测试的步骤、环境变量、Docker/数据库/缓存等基础设施、验证清单);任务手册(新增 API 端点、运行与编写测试、创建并应用迁移、部署到预发/生产、安全添加依赖);调试指南(常见错误信息与修复、各环境日志位置、诊断 SQL/CLI 查询、本地复现生产问题);受众感知输出(面向初级、资深工程师与外包人员分别调整内容与深度)。

使用方式:先确认三项输入——目标代码库路径、受众、输出格式(Markdown/Notion/Confluence);若未知应询问而非假设,用户说“直接起草”时可继续并在文首列出假设。工具命令:python scripts/architecture_mapper.py /path/to/project --json;python scripts/onboarding_generator.py /path/to/project --json;python scripts/setup_validator.py /path/to/project --json。三者均可选目录参数(默认当前目录)与 --json。参考文件按需加载:fact-gathering-and-patterns.md、documentation-templates.md、quality-and-best-practices.md。

适用场景与限制:不覆盖从代码注解自动生成 API 参考、持续文档流水线或 CI 触发构建、威胁模型等安全文档、事件响应与生产运维手册。可与 runbook-generator、api-design-reviewer、database-schema-designer、tech-debt-tracker、ci-cd-pipeline-builder、dependency-auditor 等技能衔接。具体收费、价格与平台支持暂未提供。