Skip to content

Commit 5e56bb1

Browse files
Update README with user guide link and cleanup
Added a link to the detailed user guide and removed outdated instructions for adding new features and understanding existing code.
1 parent 054580c commit 5e56bb1

File tree

1 file changed

+2
-108
lines changed

1 file changed

+2
-108
lines changed

README.md

Lines changed: 2 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ This will:
4343
2. Set up your AI development environment (Cursor/Claude Code)
4444
3. Generate phase templates in `docs/ai/`
4545

46+
Detailed user guide can be found [here](https://ai-devkit.com/docs/).
47+
4648
## Available Phases
4749

4850
- **Requirements**: Problem understanding, requirements gathering, and success criteria
@@ -240,114 +242,6 @@ Commands can be referenced in Claude Code chats to guide AI assistance through y
240242
8. **Monitor and iterate:**
241243
- Set up monitoring per `docs/ai/monitoring/README.md`
242244

243-
### Adding a New Feature
244-
245-
**Use the `/new-requirement` command for a guided workflow:**
246-
247-
1. **In Cursor or Claude Code**, type `/new-requirement`
248-
2. The AI will guide you through:
249-
- 📋 Capturing requirement details
250-
- 🔍 Creating feature-specific documentation
251-
- 📐 Designing the solution
252-
- 📅 Planning tasks and breaking down work
253-
- 💻 Implementation (task by task)
254-
- ✅ Testing and verification
255-
- 🔀 Git commits and PR/MR creation
256-
257-
**Review and refine your documentation:**
258-
- After drafting requirements, run `/review-requirements` to validate completeness
259-
- After drafting design, run `/review-design` to ensure architecture clarity and mermaid diagrams
260-
261-
**Execute your plan:**
262-
- Run `/execute-plan` to step through tasks interactively:
263-
- Reads `docs/ai/planning/feature-{name}.md`
264-
- Presents tasks in order with context
265-
- Captures status/notes for each task
266-
- Prompts you to update documentation as you progress
267-
268-
**Before pushing your code:**
269-
- Run `/code-review` to perform a structured local review:
270-
- Checks alignment with design docs
271-
- Spots logic/security/performance issues
272-
- Highlights redundant code and missing tests
273-
- Suggests documentation updates
274-
275-
**Generate comprehensive tests:**
276-
- Run `/writing-test` to create unit and integration tests targeting 100% coverage
277-
278-
This workflow creates feature-specific files:
279-
- `docs/ai/requirements/feature-{name}.md`
280-
- `docs/ai/design/feature-{name}.md`
281-
- `docs/ai/planning/feature-{name}.md`
282-
- `docs/ai/implementation/feature-{name}.md`
283-
- `docs/ai/testing/feature-{name}.md`
284-
285-
### Understanding Existing Code
286-
287-
**Use the `/capture-knowledge` command to analyze and document code:**
288-
289-
The `capture-knowledge` command helps you understand how existing code works by analyzing it from any entry point and generating comprehensive documentation with visual diagrams.
290-
291-
**In Cursor:**
292-
```
293-
/capture-knowledge <entry-point> [options]
294-
```
295-
296-
**In Claude Code:**
297-
```
298-
Use the capture-knowledge command to analyze <entry-point>
299-
```
300-
301-
**Entry Point Types:**
302-
- **File**: `/capture-knowledge src/api/users.ts` - Analyzes a specific file
303-
- **Folder**: `/capture-knowledge src/services/` - Analyzes an entire module
304-
- **Function**: `/capture-knowledge calculateTotalPrice` - Analyzes a specific function
305-
- **API Endpoint**: `/capture-knowledge POST:/api/users` - Analyzes an API endpoint flow
306-
307-
**What You Get:**
308-
- 📖 **Detailed Explanation**: Natural language description of how the code works
309-
- 🔍 **Implementation Details**: Key components, logic flow, and design patterns
310-
- 🔗 **Recursive Dependency Analysis**: Automatically traces and explains all dependencies
311-
- 📊 **Mermaid Diagrams**: Visual flowcharts, sequence diagrams, and architecture diagrams
312-
- 💡 **Insights**: Performance considerations, security notes, potential improvements
313-
314-
**Example Outputs:**
315-
316-
For functions, you get:
317-
- Flowchart showing execution path
318-
- Parameter and return value documentation
319-
- Called functions and their purposes
320-
- Error handling strategy
321-
322-
For API endpoints, you get:
323-
- Sequence diagram showing request flow
324-
- Validation and authentication steps
325-
- Database operations
326-
- Response format
327-
328-
For modules/folders, you get:
329-
- Architecture diagram showing component relationships
330-
- Overview of each file's purpose
331-
- Module boundaries and dependencies
332-
333-
**Use Cases:**
334-
- 🎯 Onboarding new developers to understand the codebase
335-
- 📚 Generating documentation for complex systems
336-
- 🔍 Debugging by understanding complete execution flow
337-
- 🏗️ Refactoring with full context of dependencies
338-
- 📖 Creating knowledge base entries
339-
340-
**Example Workflow:**
341-
```bash
342-
# Document an entire authentication module
343-
/capture-knowledge @src/auth/
344-
345-
# Analyze an API endpoint
346-
/capture-knowledge POST:/api/checkout
347-
```
348-
349-
The analysis is saved to `docs/ai/knowledge/` and can be versioned alongside your code.
350-
351245
## Use Cases
352246

353247
- **New Projects**: Scaffold complete development documentation

0 commit comments

Comments
 (0)