用途
devdocs-onboard 用于生成项目上下文摘要,解决 AI 工具或团队成员之间上下文传递的问题。当用户切换 AI 工具、开始新的对话会话、团队成员需要了解项目,或用户要求生成项目简报时,可使用该技能。其核心理念是:一份文档包含所有关键上下文,新 AI 读取后能立即开始工作,避免重复探索和询问。
主要能力
该技能提供三种运行模式:
/devdocs-onboard:智能检测模式。检测 00-context.md 是否存在,不存在则自动进入更新模式;存在则询问用户选择“读取现有内容”或“重新扫描更新”。/devdocs-onboard --read:只读模式。读取并展示现有文档,不修改任何内容。/devdocs-onboard --update:更新模式。强制重新扫描项目并更新文档。
工作流程为:扫描 DevDocs 文档 → 提取关键信息(项目概述、技术架构、当前进度、待办任务)→ 扫描代码库结构 → 生成上下文摘要 → 输出文件。
输出文件为 docs/devdocs/00-context.md,设计为可直接复制给新 AI 工具作为初始上下文。文档结构包含:项目概述、系统架构、代码结构、当前进度、待办任务、重要约定、快速开始、DevDocs 文档索引。
信息提取规则:从 DevDocs 文档提取项目目标、功能列表、技术栈、架构图、核心接口、当前进度、待办任务;从代码库提取目录结构、关键文件、未提交变更、提交风格、运行命令。
使用方式
基本命令:
# 智能检测:根据文档存在状态询问用户
/devdocs-onboard
# 只读模式:读取并展示现有文档,不做任何修改
/devdocs-onboard --read
# 更新模式:强制重新扫描项目并更新文档
/devdocs-onboard --update
使用场景示例:
场景一:完成工作,准备交接(--update)。用户运行 /devdocs-onboard --update,Agent 扫描项目并生成上下文,更新 docs/devdocs/00-context.md,用户可将此文件内容复制给新的 AI 工具。
场景二:新 AI 接手项目(--read)。用户运行 /devdocs-onboard --read,Agent 读取项目上下文并展示内容,提示当前进度和下一步任务。
场景三:不确定时(智能检测)。用户运行 /devdocs-onboard,Agent 检测到文档已存在并询问用户选择读取或更新。
语言规则:支持中英文提问,统一中文回复,使用中文生成文档。
适用场景
- 用户切换 AI 工具,需要传递上下文
- 用户开始新的对话会话
- 团队成员需要了解项目
- 用户要求生成项目简报
限制与约束
生成约束:必须扫描所有 DevDocs 文档;必须检查当前代码库状态;必须包含未提交变更信息;输出文件必须自包含(不依赖外部链接理解);关键信息必须直接展示(不只是引用文档路径)。
内容约束:项目概述不超过 200 字;架构图必须包含(ASCII 或 Mermaid);必须列出下一步可执行的任务;敏感信息(密钥、密码)不得包含;文件路径必须准确可访问。
更新约束:每次生成覆盖旧文件;生成时间必须记录;如 DevDocs 不存在,提示用户先运行相关 skill。
Skill 协作:DevDocs 不存在时可先运行 /devdocs-retrofit 从代码逆向生成文档;进度信息过时时可先运行 /devdocs-sync 同步文档状态;需要详细任务时可查看 /devdocs-dev-tasks;记忆文件同步可使用 /agent-memory 更新 AGENTS.md。
当本 Skill 作为子 Agent 运行时,返回结构化摘要,包含 skill、mode、summary(项目名、进度、下一步任务、阻塞项)、context_age、status、output_file 等字段。