Skip to content

Commit be3ebd9

Browse files
committed
Update document for development with ai-devkit
1 parent 021ef64 commit be3ebd9

File tree

1 file changed

+118
-39
lines changed

1 file changed

+118
-39
lines changed

web/content/docs/3-development-with-ai-devkit.md

Lines changed: 118 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,66 +5,145 @@ slug: development-with-ai-devkit
55
order: 3
66
---
77

8-
## Start with `/new-requirement`
8+
AI DevKit provides a structured workflow that takes you from idea to deployed feature. Instead of jumping straight into code, you'll create documentation at each phase—this gives your AI assistant the context it needs to help you effectively.
99

10-
The `/new-requirement` command is your entry point for any new feature development. It guides you through a complete development lifecycle:
10+
## Why Structured Development?
1111

12-
```bash
13-
# In Cursor or Claude Code
12+
When you work with AI assistants without structure, you often:
13+
- Lose context between sessions
14+
- Repeat yourself explaining requirements
15+
- End up with inconsistent code and documentation
16+
17+
AI DevKit solves this by creating documentation as you go. Each document becomes context for the next phase, so your AI assistant always knows what you're building and why.
18+
19+
## The Development Lifecycle
20+
21+
### 1. Start with `/new-requirement`
22+
23+
The `/new-requirement` command is your entry point for any new feature. It guides you through the complete lifecycle:
24+
25+
```
1426
/new-requirement
1527
```
1628

1729
**What happens:**
18-
1. **Requirements Capture** - Define what you're building and why
19-
2. **Design Phase** - Create architecture and technical specifications
20-
3. **Planning** - Break down work into actionable tasks
21-
4. **Implementation** - Step-by-step coding with guidance
22-
5. **Testing** - Generate comprehensive test coverage
23-
6. **Git Workflow** - Structured commits and PR creation
24-
25-
**Generated Documentation:**
26-
- `docs/ai/requirements/feature-{name}.md` - Requirements and user stories
27-
- `docs/ai/design/feature-{name}.md` - Architecture and technical design
28-
- `docs/ai/planning/feature-{name}.md` - Task breakdown and timeline
29-
- `docs/ai/implementation/feature-{name}.md` - Implementation notes
30-
- `docs/ai/testing/feature-{name}.md` - Test strategy and cases
31-
32-
### Refine Your Work
33-
34-
**Review Requirements:**
35-
```bash
30+
31+
| Phase | What You Do |
32+
|-------|-------------|
33+
| **Requirements** | Define what you're building and why |
34+
| **Design** | Create architecture and technical specs |
35+
| **Planning** | Break work into actionable tasks |
36+
| **Implementation** | Code with step-by-step guidance |
37+
| **Testing** | Generate comprehensive test coverage |
38+
39+
**Documentation created:**
40+
41+
```
42+
docs/ai/
43+
├── requirements/feature-{name}.md # What and why
44+
├── design/feature-{name}.md # Architecture
45+
├── planning/feature-{name}.md # Task breakdown
46+
├── implementation/feature-{name}.md # Implementation notes
47+
└── testing/feature-{name}.md # Test strategy
48+
```
49+
50+
> **Tip:** You don't have to complete all phases in one session. AI DevKit saves your documentation, so you can pick up where you left off.
51+
52+
## Refinement Commands
53+
54+
After the initial pass, use these commands to refine your work:
55+
56+
### `/review-requirements`
57+
58+
```
3659
/review-requirements
3760
```
38-
Validates completeness and identifies gaps in your requirements.
3961

40-
**Review Design:**
41-
```bash
62+
**When to use:** Before starting design, to catch gaps in your requirements.
63+
64+
**What it does:**
65+
- Validates completeness of requirements
66+
- Identifies missing acceptance criteria
67+
- Suggests clarifying questions
68+
69+
### `/review-design`
70+
71+
```
4272
/review-design
4373
```
44-
Ensures architecture clarity and generates Mermaid diagrams.
4574

46-
**Execute Your Plan:**
47-
```bash
75+
**When to use:** After design, before implementation, to ensure your architecture is solid.
76+
77+
**What it does:**
78+
- Ensures architecture clarity
79+
- Generates Mermaid diagrams for visualization
80+
- Checks alignment with requirements
81+
82+
### `/execute-plan`
83+
84+
```
4885
/execute-plan
4986
```
50-
Interactive task execution that:
87+
88+
**When to use:** During implementation, to work through tasks systematically.
89+
90+
**What it does:**
5191
- Reads your planning document
5292
- Presents tasks in logical order
53-
- Captures progress and notes
54-
- Prompts documentation updates
93+
- Tracks progress and captures notes
94+
- Prompts documentation updates as you go
95+
96+
### `/update-planning`
97+
98+
```
99+
/update-planning
100+
```
101+
102+
**When to use:** When implementation drifts from the original plan.
103+
104+
**What it does:**
105+
- Syncs planning documentation with actual progress
106+
- Updates task status and notes
107+
- Keeps documentation current
108+
109+
## Quality Commands
110+
111+
### `/code-review`
55112

56-
**Code Review:**
57-
```bash
113+
```
58114
/code-review
59115
```
60-
Pre-commit review that checks:
116+
117+
**When to use:** Before committing, to catch issues early.
118+
119+
**What it checks:**
61120
- Alignment with design documents
62121
- Logic, security, and performance issues
63-
- Code redundancy and missing tests
64-
- Documentation completeness
122+
- Code redundancy and duplication
123+
- Missing tests and documentation
65124

66-
**Generate Tests:**
67-
```bash
125+
### `/writing-test`
126+
127+
```
68128
/writing-test
69129
```
70-
Creates unit and integration tests targeting high coverage.
130+
131+
**When to use:** After implementation, to ensure coverage.
132+
133+
**What it does:**
134+
- Generates unit and integration tests
135+
- Targets high coverage of your new code
136+
- Follows your project's testing conventions
137+
138+
## Tips for Success
139+
140+
1. **Don't skip phases** — Each phase builds context for the next
141+
2. **Keep docs updated** — Use `/update-planning` when things change
142+
3. **Review before committing**`/code-review` catches issues early
143+
4. **Be specific** — The more detail you give, the better your AI assistant can help
144+
145+
## Next Steps
146+
147+
- **Debug effectively** — See [Debugging with AI DevKit](/docs/debugging-with-ai-devkit)
148+
- **Understand existing code** — See [Understanding Existing Code](/docs/understand-existing-code-with-ai-devkit)
149+
- **Give your AI memory** — See [Memory](/docs/memory)

0 commit comments

Comments
 (0)