SuperAPI AI 工具集

onboard-developer

编程与开发

查看项目

更新于 10-15 21:42

技能介绍

用途:为项目新成员生成“如何在此工作”的上手文档。它与 generate-docs 的区别在于,后者记录代码库架构,本技能记录开发者体验:安装步骤、日常工作流、约定、常见任务和排错。适合在新人加入、用户询问“如何开始这个项目”、以及已运行过 generate-docs 之后使用。

主要能力与流程:第一阶段由主智能体分析项目的安装要求、脚本和约定;第二阶段启动 doc-explorer,将上手指南写入 docs/onboarding.md。

分析内容:检查语言与运行时版本(如 node --version、python3 --version、go version)、包管理器锁文件(package-lock.json、yarn.lock、pnpm-lock.yaml、pyproject.toml、requirements.txt)、开发工具配置(Makefile、.tool-versions、.node-version)。从 package.json 脚本、Makefile 或 CI 中提取本地运行、测试、lint/format、构建和部署方式。从 AGENTS.md、.editorconfig、linter 配置和 git 钩子中提取分支命名、提交信息格式、代码风格和 PR 流程,并强调引用 AGENTS.md 作为唯一事实来源而非重复其内容。从 generate-docs 输出或直接分析中梳理入口点、核心模块、配置位置和测试方式。

输出结构:生成的 docs/onboarding.md 包含 Prerequisites、Quick Start(克隆、安装、运行、测试)、Project Structure、Daily Workflow(建分支、改代码、运行检查、提交、推送并创建 PR)、Common Tasks、Conventions、Troubleshooting 和 Useful Links 等小节。

规则与限制:内容应可操作而非仅描述,命令需可直接复制粘贴且不含占位符,Quick Start 力求让新人 5 分钟内从零到可运行,并包含已知问题的排错提示。不要使用内置的 explore 子智能体类型。文档的具体命令、链接和常见问题内容取决于目标项目实际配置,具体细节需以项目为准,本资料未提供。