ai-sprint-kit 1.1.8 → 1.2.0

package/templates/docs/user-guide.md

@@ -27,14 +27,14 @@ Complete guide to using the autonomous development framework with Claude Code.
 # 1. Start Claude Code
 claude
 
-# 2. Try the /auto command for full automation
-/auto "create a hello world API endpoint"
+# 2. Try the /ai-sprint-auto command for full automation
+/ai-sprint-auto "create a hello world API endpoint"
 
 # 3. Or step-by-step approach
-/plan "create REST API endpoint"
-/code "implement the plan"
-/test
-/validate
+/ai-sprint-plan "create REST API endpoint"
+/ai-sprint-code "implement the plan"
+/ai-sprint-test
+/ai-sprint-validate
 ```
 
 ### Project Structure
@@ -66,7 +66,7 @@ your-project/
 The simplest way - let the framework handle everything:
 
 ```bash
-/auto "implement user registration with email and password"
+/ai-sprint-auto "implement user registration with email and password"
 ```
 
 This automatically runs: plan → code → test → review → security → docs
@@ -79,23 +79,23 @@ For more control over each phase:
 
 ```bash
 # Step 1: Create the plan
-/plan "implement user registration with email verification"
+/ai-sprint-plan "implement user registration with email verification"
 # Review the plan in ai_context/plans/
 
 # Step 2: Generate code
-/code "implement the registration feature from the plan"
+/ai-sprint-code "implement the registration feature from the plan"
 
 # Step 3: Generate and run tests
-/test
+/ai-sprint-test
 
 # Step 4: Review code quality
-/review
+/ai-sprint-review
 
 # Step 5: Security scan
-/secure
+/ai-sprint-secure
 
 # Step 6: Generate documentation
-/docs
+/ai-sprint-docs
 ```
 
 **When to use:** Complex features, learning the framework, when you need review at each step.
@@ -104,25 +104,25 @@ For more control over each phase:
 
 ```bash
 # Step 1: Investigate the issue
-/debug "users getting 500 error when submitting registration form"
+/ai-sprint-debug "users getting 500 error when submitting registration form"
 # Review the analysis in ai_context/reports/
 
 # Step 2: Implement the fix
-/code "fix the registration error based on debug analysis"
+/ai-sprint-code "fix the registration error based on debug analysis"
 
 # Step 3: Verify fix
-/test
-/validate
+/ai-sprint-test
+/ai-sprint-validate
 ```
 
 ### Tutorial 4: Security Audit
 
 ```bash
 # Scan entire codebase
-/secure
+/ai-sprint-secure
 
 # Scan specific directory
-/secure src/auth/
+/ai-sprint-secure src/auth/
 
 # Review findings in ai_context/reports/security-*.md
 ```
@@ -132,7 +132,7 @@ For more control over each phase:
 Always run before pushing code:
 
 ```bash
-/validate
+/ai-sprint-validate
 ```
 
 This runs: tests + code review + security scan. Blocks if:
@@ -147,31 +147,31 @@ This runs: tests + code review + security scan. Blocks if:
 npx ai-sprint-kit init
 
 # Scan existing code for issues
-/secure
+/ai-sprint-secure
 
 # Review code quality
-/review
+/ai-sprint-review
 
 # Generate missing documentation
-/docs
+/ai-sprint-docs
 ```
 
 ---
 
 ## Command Reference
 
-### /plan - Architecture & Planning
+### /ai-sprint-plan - Architecture & Planning
 
 Creates implementation plans with architecture decisions.
 
 ```bash
 # Basic usage
-/plan "implement feature description"
+/ai-sprint-plan "implement feature description"
 
 # Examples
-/plan "add OAuth2 authentication with Google and GitHub"
-/plan "create microservices architecture for order processing"
-/plan "implement real-time notifications using WebSockets"
+/ai-sprint-plan "add OAuth2 authentication with Google and GitHub"
+/ai-sprint-plan "create microservices architecture for order processing"
+/ai-sprint-plan "implement real-time notifications using WebSockets"
 ```
 
 **Output:** `ai_context/plans/{timestamp}-{feature}/plan.md`
@@ -180,35 +180,35 @@ Creates implementation plans with architecture decisions.
 
 ---
 
-### /code - Code Generation
+### /ai-sprint-code - Code Generation
 
 Generates or refactors code based on plans or descriptions.
 
 ```bash
 # Basic usage
-/code "what to implement"
+/ai-sprint-code "what to implement"
 
 # Examples
-/code "implement the authentication plan"
-/code "refactor the user service to use dependency injection"
-/code "add input validation to all API endpoints"
+/ai-sprint-code "implement the authentication plan"
+/ai-sprint-code "refactor the user service to use dependency injection"
+/ai-sprint-code "add input validation to all API endpoints"
 ```
 
 **Best for:** Implementation, refactoring, adding functionality.
 
 ---
 
-### /test - Testing
+### /ai-sprint-test - Testing
 
 Generates tests and runs them with coverage.
 
 ```bash
 # Basic usage
-/test
+/ai-sprint-test
 
 # With specific focus
-/test "focus on edge cases for user registration"
-/test "add integration tests for payment API"
+/ai-sprint-test "focus on edge cases for user registration"
+/ai-sprint-test "add integration tests for payment API"
 ```
 
 **Output:** `ai_context/reports/test-*.md`
@@ -217,17 +217,17 @@ Generates tests and runs them with coverage.
 
 ---
 
-### /review - Code Review
+### /ai-sprint-review - Code Review
 
 Analyzes code quality and best practices.
 
 ```bash
 # Review all recent changes
-/review
+/ai-sprint-review
 
 # Review specific files or directories
-/review src/services/
-/review src/auth/login.ts
+/ai-sprint-review src/services/
+/ai-sprint-review src/auth/login.ts
 ```
 
 **Output:** `ai_context/reports/review-*.md`
@@ -241,17 +241,17 @@ Analyzes code quality and best practices.
 
 ---
 
-### /secure - Security Scanning
+### /ai-sprint-secure - Security Scanning
 
 Comprehensive security analysis.
 
 ```bash
 # Scan entire project
-/secure
+/ai-sprint-secure
 
 # Scan specific directory
-/secure src/
-/secure src/auth/
+/ai-sprint-secure src/
+/ai-sprint-secure src/auth/
 ```
 
 **Output:** `ai_context/reports/security-*.md`
@@ -264,50 +264,50 @@ Comprehensive security analysis.
 
 ---
 
-### /deploy - CI/CD Setup
+### /ai-sprint-deploy - CI/CD Setup
 
 Configures deployment pipelines.
 
 ```bash
 # Basic setup
-/deploy
+/ai-sprint-deploy
 
 # Platform-specific
-/deploy --platform github
-/deploy --platform gitlab
-/deploy --platform azure
+/ai-sprint-deploy --platform github
+/ai-sprint-deploy --platform gitlab
+/ai-sprint-deploy --platform azure
 ```
 
 **Creates:** CI/CD configuration files for your platform.
 
 ---
 
-### /docs - Documentation
+### /ai-sprint-docs - Documentation
 
 Generates technical documentation.
 
 ```bash
 # Generate all docs
-/docs
+/ai-sprint-docs
 
 # Focus on specific areas
-/docs "API documentation"
-/docs "update README with new features"
+/ai-sprint-docs "API documentation"
+/ai-sprint-docs "update README with new features"
 ```
 
 **Output:** `ai_context/docs/` and project `docs/`
 
 ---
 
-### /debug - Debugging
+### /ai-sprint-debug - Debugging
 
 Investigates issues and bugs.
 
 ```bash
 # Describe the problem
-/debug "500 error when user submits form"
-/debug "memory leak in background job processor"
-/debug "slow API response times on /users endpoint"
+/ai-sprint-debug "500 error when user submits form"
+/ai-sprint-debug "memory leak in background job processor"
+/ai-sprint-debug "slow API response times on /users endpoint"
 ```
 
 **Output:** `ai_context/reports/debug-*.md`
@@ -319,12 +319,12 @@ Investigates issues and bugs.
 
 ---
 
-### /validate - Pre-Commit Gate
+### /ai-sprint-validate - Pre-Commit Gate
 
 Runs comprehensive validation before commit.
 
 ```bash
-/validate
+/ai-sprint-validate
 ```
 
 **Runs:** tests + review + security
@@ -338,17 +338,17 @@ Runs comprehensive validation before commit.
 
 ---
 
-### /auto - Full Automation
+### /ai-sprint-auto - Full Automation
 
 Complete development cycle in one command.
 
 ```bash
-/auto "feature description"
+/ai-sprint-auto "feature description"
 
 # Examples
-/auto "implement shopping cart with add, remove, checkout"
-/auto "create admin dashboard for user management"
-/auto "add rate limiting to all API endpoints"
+/ai-sprint-auto "implement shopping cart with add, remove, checkout"
+/ai-sprint-auto "create admin dashboard for user management"
+/ai-sprint-auto "add rate limiting to all API endpoints"
 ```
 
 **Runs:** plan → code → test → review → security → docs
@@ -438,21 +438,21 @@ Edit `.mcp.json`:
 
 ## Best Practices
 
-### 1. Start with /plan
+### 1. Start with /ai-sprint-plan
 
 Always plan before coding for complex features:
 
 ```bash
-/plan "describe your feature"
+/ai-sprint-plan "describe your feature"
 # Review the plan
-/code "implement the plan"
+/ai-sprint-code "implement the plan"
 ```
 
-### 2. Use /validate Before Every Commit
+### 2. Use /ai-sprint-validate Before Every Commit
 
 ```bash
 # Before git commit
-/validate
+/ai-sprint-validate
 git add .
 git commit -m "feat: your feature"
 ```
@@ -471,7 +471,7 @@ cat ai_context/memory/decisions.md
 
 ### 4. Review Security Reports
 
-After every `/secure` scan:
+After every `/ai-sprint-secure` scan:
 
 ```bash
 # Check reports
@@ -485,12 +485,12 @@ Set up at least:
 - **exa** - For better web search
 - **context7** - For library documentation
 
-### 6. Use /auto for Simple Features
+### 6. Use /ai-sprint-auto for Simple Features
 
 For straightforward features, use full automation:
 
 ```bash
-/auto "add logout button to navbar"
+/ai-sprint-auto "add logout button to navbar"
 ```
 
 ### 7. Use Step-by-Step for Complex Features
@@ -498,13 +498,13 @@ For straightforward features, use full automation:
 For complex features, maintain control:
 
 ```bash
-/plan "complex feature"
+/ai-sprint-plan "complex feature"
 # Review plan
-/code "implement phase 1"
-/test
-/code "implement phase 2"
-/test
-/validate
+/ai-sprint-code "implement phase 1"
+/ai-sprint-test
+/ai-sprint-code "implement phase 2"
+/ai-sprint-test
+/ai-sprint-validate
 ```
 
 ---
@@ -515,17 +515,17 @@ For complex features, maintain control:
 
 ```bash
 # Run tests to see errors
-/test
+/ai-sprint-test
 
 # Debug specific failures
-/debug "test X is failing with error Y"
+/ai-sprint-debug "test X is failing with error Y"
 ```
 
 ### Low Coverage
 
 ```bash
 # Generate more tests
-/test "increase coverage for uncovered functions"
+/ai-sprint-test "increase coverage for uncovered functions"
 ```
 
 ### Security Issues Found
@@ -535,10 +535,10 @@ For complex features, maintain control:
 cat ai_context/reports/security-*.md
 
 # Fix issues
-/code "fix security issues from the security scan"
+/ai-sprint-code "fix security issues from the security scan"
 
 # Rescan
-/secure
+/ai-sprint-secure
 ```
 
 ### Agent Not Responding
@@ -579,16 +579,16 @@ npx ai-sprint-kit init --force
 
 | Task | Command |
 |------|---------|
-| Full automation | `/auto "feature"` |
-| Plan feature | `/plan "feature"` |
-| Write code | `/code "what to build"` |
-| Run tests | `/test` |
-| Code review | `/review` |
-| Security scan | `/secure` |
-| Setup CI/CD | `/deploy` |
-| Generate docs | `/docs` |
-| Debug issue | `/debug "problem"` |
-| Pre-commit check | `/validate` |
+| Full automation | `/ai-sprint-auto "feature"` |
+| Plan feature | `/ai-sprint-plan "feature"` |
+| Write code | `/ai-sprint-code "what to build"` |
+| Run tests | `/ai-sprint-test` |
+| Code review | `/ai-sprint-review` |
+| Security scan | `/ai-sprint-secure` |
+| Setup CI/CD | `/ai-sprint-deploy` |
+| Generate docs | `/ai-sprint-docs` |
+| Debug issue | `/ai-sprint-debug "problem"` |
+| Pre-commit check | `/ai-sprint-validate` |
 
 ---