devdocs-onboard
Original:🇨🇳 Chinese
Translated
Generate project context summaries for AI tool handovers. Use this tool when switching AI tools, starting new sessions, or onboarding team members. It triggers on keywords such as "project context", "handover", "onboard", "project context", "handover", and "taking over a project".
4installs
Sourceab300819/skills
Added on
NPX Install
npx skill4agent add ab300819/skills devdocs-onboardTags
Translated version includes tags in frontmatterSKILL.md Content (Chinese)
View Translation Comparison →Project Context
Generate project context summaries to help AI tools or team members quickly understand and take over the project.
Operation Modes
/devdocs-onboard → Smart Detection (Ask whether to read or write)
/devdocs-onboard --read → Only read existing documents, no modifications
/devdocs-onboard --update → Force rescan and update| Mode | Read Documents | Scan Project | Write File | Applicable Scenario |
|---|---|---|---|---|
| Smart Detection | ✅ | As needed | As needed | When uncertain |
| ✅ | ❌ | ❌ | New AI taking over project |
| - | ✅ | ✅ | After completing phase work |
Smart Detection Flow
Check if 00-context.md exists
│
├── Does not exist → Automatically enter update mode
│
└── Exists → Ask user
├── "Read existing content" → Display document, no modifications
└── "Rescan and update" → Scan project, overwrite fileLanguage Rules
- Support queries in both Chinese and English
- Provide unified English responses
- Generate documents in English
Trigger Conditions
- User switches AI tools and needs to transfer context
- User starts a new conversation session
- Team members need to understand the project
- User requests to generate a project brief
Core Concepts
Context Transfer Issues
Session A (Claude Code) Session B (New AI Tool)
│ │
├── Understand project structure │ ← Needs to re-understand
├── Read design documents │ ← Needs to re-read
├── Understand current progress │ ← Needs to re-understand
└── Know next tasks │ ← Needs to re-confirm
│
┌────────────────┘
▼
/devdocs-onboard
│
▼
Generate context summary
│
▼
Quickly take over projectCore Principles:
- A single document contains all key context
- New AI can start working immediately after reading
- Avoid repeated exploration and inquiries
Workflow
1. Scan DevDocs documents
│
▼
2. Extract key information
├── Project Overview
├── Technical Architecture
├── Current Progress
└── Pending Tasks
│
▼
3. Scan codebase structure
│
▼
4. Generate context summary
│
▼
5. Output file (can be directly passed to new AI)Output File
Main File:
docs/devdocs/00-context.mdThis file is designed to be directly copied to new AI tools as initial context.
Document Structure
markdown
# Project Context: <Project Name>
**Generation Time**: YYYY-MM-DD HH:mm
**Generation Tool**: /devdocs-onboard
---
## 1. Project Overview
### 1.1 Project Objectives
<Extracted from 01-requirements.md>
### 1.2 Core Features
| ID | Feature | Status |
|------|------|------|
| F-001 | <Feature Name> | ✅ Completed / 🔄 In Progress / ⏳ Pending Development |
### 1.3 Tech Stack
<Extracted from 02-system-design.md>
---
## 2. System Architecture
### 2.1 Architecture Overview
<Extract architecture diagram from 02-system-design.md>
### 2.2 Core Modules
| Module | Responsibility | Key Files |
|------|------|----------|
| <Module Name> | <Responsibility> | `src/xxx/` |
### 2.3 Core Interfaces
<Extract key interface signatures from 02-system-design.md>
---
## 3. Code Structure
### 3.1 Directory Structure<Actual project directory structure, obtained via ls/tree>
### 3.2 Key File Explanations
| File | Purpose |
|------|------|
| `src/index.ts` | Entry file |
| `src/config.ts` | Configuration management |
---
## 4. Current Progress
### 4.1 Overall Progress
| Type | Total | Completed | In Progress | Completion Rate |
|------|------|--------|--------|--------|
| Feature Points | X | X | X | XX% |
| Development Tasks | X | X | X | XX% |
### 4.2 Recently Completed
- T-05: <Task Name> (YYYY-MM-DD)
- T-04: <Task Name> (YYYY-MM-DD)
### 4.3 In Progress
- T-06: <Task Name>
- Status: <Progress Description>
- Involved Files: `src/xxx.ts`
### 4.4 Uncommitted Changes
<List any uncommitted code changes>
---
## 5. Pending Tasks
### 5.1 Next Tasks
| Priority | Task | Dependencies | Associated Requirements |
|--------|------|------|----------|
| P0 | T-07: <Task Name> | T-06 | F-002, AC-005 |
### 5.2 Blockers
<List any blockers>
---
## 6. Important Agreements
### 6.1 Coding Standards
- Follow MTE principles (Maintainable, Testable, Extensible)
- Functions no longer than 50 lines
- No more than 5 parameters
### 6.2 Testing Requirements
- Unit test coverage ≥ 80%
- Forbid weak assertions
### 6.3 Commit Standards
<Extract project commit style from git log>
---
## 7. Quick Start
### 7.1 Environment Preparation
```bash
<Dependency installation commands>7.2 Run Project
bash
<Run commands>7.3 Run Tests
bash
<Test commands>8. DevDocs Document Index
| Document | Path | Description |
|---|---|---|
| Requirements Document | | Feature points, user stories, acceptance criteria |
| System Design | | Architecture, interfaces, data models |
| Test Cases | | Testing strategies, traceability matrix |
| Development Tasks | | Task lists, dependency relationships |
Takeover Recommendations:
- First read this document to get the full picture
- Check the status of "In Progress" tasks
- Continue development from the "Next Tasks" section
- Refer to the corresponding DevDocs documents when encountering detailed issues
## Information Extraction Rules
### Extract from DevDocs
| Information | Source Document | Extracted Content |
|------|----------|----------|
| Project Objectives | `01-requirements.md` | Requirements background, target users |
| Feature List | `01-requirements.md` | F-XXX feature points and statuses |
| Tech Stack | `02-system-design.md` | Technology selection table |
| Architecture Diagram | `02-system-design.md` | Architecture overview diagram |
| Core Interfaces | `02-system-design.md` | Interface signature table |
| Current Progress | `04-dev-tasks.md` | Execution checklist |
| Pending Tasks | `04-dev-tasks.md` | Uncompleted T-XX tasks |
### Extract from Codebase
| Information | Extraction Method |
|------|----------|
| Directory Structure | `ls -la` or `tree` |
| Key Files | Analyze package.json, entry files |
| Uncommitted Changes | `git status` |
| Commit Style | `git log --oneline -5` |
| Run Commands | Extract from package.json scripts or Makefile |
## Usage Scenarios
### Scenario 1: Complete work and prepare for handover (--update)
User: /devdocs-onboard --update
Agent: Scanning project and generating context...
✅ Updated docs/devdocs/00-context.md
You can copy the content of this file to the new AI tool, which will quickly understand and take over the project.
### Scenario 2: New AI takes over project (--read)
User: /devdocs-onboard --read
Agent: Reading project context...
[Displays content of 00-context.md]
Current Progress: 8/12 tasks completed (67%)
Next Step: T-09 User Authentication Module
It is recommended to continue development from the "Pending Tasks" section.
### Scenario 3: Uncertain (Smart Detection)
User: /devdocs-onboard
Agent: Detected that docs/devdocs/00-context.md already exists (updated 2 hours ago)
Please select:
- Read existing content (no modifications)
- Rescan and update
User: 1
Agent: [Displays existing document content]
## Constraints
### Generation Constraints
- [ ] **Must scan all DevDocs documents**
- [ ] **Must check current codebase status**
- [ ] **Must include uncommitted changes information**
- [ ] Output files must be self-contained (no external links required for understanding)
- [ ] Key information must be directly displayed (not just referencing document paths)
### Content Constraints
- [ ] **Project overview must not exceed 200 words**
- [ ] **Architecture diagram must be included (ASCII or Mermaid)**
- [ ] **Must list executable next-step tasks**
- [ ] Sensitive information (keys, passwords) must not be included
- [ ] File paths must be accurate and accessible
### Update Constraints
- [ ] Overwrite old file with each generation
- [ ] Must record generation time
- [ ] If DevDocs do not exist, prompt user to run the relevant skill first
## Skill Collaboration
| Scenario | Collaborative Skill | Description |
|------|-----------|------|
| DevDocs do not exist | `/devdocs-retrofit` | First reverse-generate documents from code |
| Progress information is outdated | `/devdocs-sync` | First sync document status |
| Need detailed tasks | `/devdocs-dev-tasks` | View complete task list |
## Command Options
```bash
# Smart Detection: Ask user based on document existence status
/devdocs-onboard
# Read-only Mode: Read and display existing documents, no modifications
/devdocs-onboard --read
# Update Mode: Force rescan project and update document
/devdocs-onboard --updateNext Steps
Handover Party (Tool A)
- After completing phase work, run
/devdocs-onboard --update - Transfer the content of to the new AI tool
00-context.md
Takeover Party (Tool B)
- Run to understand the project
/devdocs-onboard --read - Continue development from the "Pending Tasks" section
- After completing work, run to update context
/devdocs-onboard --update