SuperAPI AI 工具集

onboard

编程与开发

查看项目

更新于 10-15 11:02

技能介绍

onboard 是 keel-workflow 提供的项目上下文摘要技能,核心用途是生成项目上下文摘要,帮助 AI 工具或团队成员快速了解项目并接手工作,也用于 AI 工具交接或新会话启动。

主要能力与运行模式:支持四种运行方式。/onboard 为智能检测,先判断 docs/devdocs/00-context.md 是否存在:不存在则自动进入更新模式,存在则询问用户选择“读取现有内容”或“重新扫描更新”。/onboard --read 只读取现有文档并展示,不扫描、不写入、不委托生成任何文件;文件不存在时提示用户先运行 --update。/onboard --update 强制重新扫描项目并更新文档。/onboard --realign 用于规范升级回扫,按当前 context.v1 对 00-context.md 查漏补缺,不重扫项目。

工作流程:--update 或 auto 模式下,会扫描 keel 文档、提取关键信息(项目概述、技术架构、当前进度、待办任务)、读取代码库盘点并采集运行态信息,其中结构化信息委托 codebase-insight 获取(模块、接口、数据对象),运行态信息由 onboard 直接采集(git status、git log、目录结构等),随后生成上下文摘要并输出文件。

输出与文档结构:主文件为 docs/devdocs/00-context.md,设计为可直接复制给新 AI 工具作为初始上下文。文档包含文件头 frontmatter(generated_by、spec_version、generated_at),以及项目概述(项目目标、核心功能、技术栈)、系统架构(架构概览、核心模块、核心接口)、代码结构(目录结构、关键文件说明)、当前进度(总体进度、最近完成、当前进行中、未提交变更)、待办任务(下一步任务、阻塞项)、重要约定(编码规范、测试要求、提交规范)、快速开始(环境准备、运行项目、运行测试)、keel 文档索引等章节,并附接手建议。

信息提取来源:项目目标、功能列表来自 01-requirements.md;技术栈、架构图、核心接口来自 02-system-design.md;当前进度与待办任务来自 04-dev-tasks.md;系统边界、核心模块、公开接口、技术栈与约束来自 codebase-insight.md;目录结构、关键文件、未提交变更、提交风格、运行命令由 onboard 直接采集。keel 文档索引会列出 docs/devdocs/ 下全部文件,匹配路径模式取 owner 作产出方,匹配不到的填“待分类”且不得省略。

适用场景:完成阶段性工作后交接(--update)、新 AI 接手项目(--read)、不确定时智能检测;触发条件包括切换 AI 工具需要传递上下文、开始新对话会话、团队成员需要了解项目、要求生成项目简报。

约束与协作:生成内容必须自包含、关键信息直接展示、架构图必须包含、必须列出下一步可执行任务、不得包含敏感信息、文件路径必须准确;每次生成覆盖旧文件并记录生成时间;keel 不存在时提示先运行相关 skill。协作方面,keel 不存在用 /retrofit 建立基线,进度信息过时用 /sync 同步,需要详细任务用 /dev-tasks,记忆文件同步用 /agent-memory。语言上支持中英文提问,统一中文回复与生成文档。价格、平台限制等信息资料暂未提供。