bmad-method 5.1.2 → 6.0.0-alpha.0

package/bmad-core/tasks/index-docs.md

@@ -1,173 +0,0 @@
-# Index Documentation Task
-
-## Purpose
-
-This task maintains the integrity and completeness of the `docs/index.md` file by scanning all documentation files and ensuring they are properly indexed with descriptions. It handles both root-level documents and documents within subfolders, organizing them hierarchically.
-
-## Task Instructions
-
-You are now operating as a Documentation Indexer. Your goal is to ensure all documentation files are properly cataloged in the central index with proper organization for subfolders.
-
-### Required Steps
-
-1. First, locate and scan:
-   - The `docs/` directory and all subdirectories
-   - The existing `docs/index.md` file (create if absent)
-   - All markdown (`.md`) and text (`.txt`) files in the documentation structure
-   - Note the folder structure for hierarchical organization
-
-2. For the existing `docs/index.md`:
-   - Parse current entries
-   - Note existing file references and descriptions
-   - Identify any broken links or missing files
-   - Keep track of already-indexed content
-   - Preserve existing folder sections
-
-3. For each documentation file found:
-   - Extract the title (from first heading or filename)
-   - Generate a brief description by analyzing the content
-   - Create a relative markdown link to the file
-   - Check if it's already in the index
-   - Note which folder it belongs to (if in a subfolder)
-   - If missing or outdated, prepare an update
-
-4. For any missing or non-existent files found in index:
-   - Present a list of all entries that reference non-existent files
-   - For each entry:
-     - Show the full entry details (title, path, description)
-     - Ask for explicit confirmation before removal
-     - Provide option to update the path if file was moved
-     - Log the decision (remove/update/keep) for final report
-
-5. Update `docs/index.md`:
-   - Maintain existing structure and organization
-   - Create level 2 sections (`##`) for each subfolder
-   - List root-level documents first
-   - Add missing entries with descriptions
-   - Update outdated entries
-   - Remove only entries that were confirmed for removal
-   - Ensure consistent formatting throughout
-
-### Index Structure Format
-
-The index should be organized as follows:
-
-```markdown
-# Documentation Index
-
-## Root Documents
-
-### [Document Title](./document.md)
-
-Brief description of the document's purpose and contents.
-
-### [Another Document](./another.md)
-
-Description here.
-
-## Folder Name
-
-Documents within the `folder-name/` directory:
-
-### [Document in Folder](./folder-name/document.md)
-
-Description of this document.
-
-### [Another in Folder](./folder-name/another.md)
-
-Description here.
-
-## Another Folder
-
-Documents within the `another-folder/` directory:
-
-### [Nested Document](./another-folder/document.md)
-
-Description of nested document.
-```
-
-### Index Entry Format
-
-Each entry should follow this format:
-
-```markdown
-### [Document Title](relative/path/to/file.md)
-
-Brief description of the document's purpose and contents.
-```
-
-### Rules of Operation
-
-1. NEVER modify the content of indexed files
-2. Preserve existing descriptions in index.md when they are adequate
-3. Maintain any existing categorization or grouping in the index
-4. Use relative paths for all links (starting with `./`)
-5. Ensure descriptions are concise but informative
-6. NEVER remove entries without explicit confirmation
-7. Report any broken links or inconsistencies found
-8. Allow path updates for moved files before considering removal
-9. Create folder sections using level 2 headings (`##`)
-10. Sort folders alphabetically, with root documents listed first
-11. Within each section, sort documents alphabetically by title
-
-### Process Output
-
-The task will provide:
-
-1. A summary of changes made to index.md
-2. List of newly indexed files (organized by folder)
-3. List of updated entries
-4. List of entries presented for removal and their status:
-   - Confirmed removals
-   - Updated paths
-   - Kept despite missing file
-5. Any new folders discovered
-6. Any other issues or inconsistencies found
-
-### Handling Missing Files
-
-For each file referenced in the index but not found in the filesystem:
-
-1. Present the entry:
-
-   ```markdown
-   Missing file detected:
-   Title: [Document Title]
-   Path: relative/path/to/file.md
-   Description: Existing description
-   Section: [Root Documents | Folder Name]
-
-   Options:
-
-   1. Remove this entry
-   2. Update the file path
-   3. Keep entry (mark as temporarily unavailable)
-
-   Please choose an option (1/2/3):
-   ```
-
-2. Wait for user confirmation before taking any action
-3. Log the decision for the final report
-
-### Special Cases
-
-1. **Sharded Documents**: If a folder contains an `index.md` file, treat it as a sharded document:
-   - Use the folder's `index.md` title as the section title
-   - List the folder's documents as subsections
-   - Note in the description that this is a multi-part document
-
-2. **README files**: Convert `README.md` to more descriptive titles based on content
-
-3. **Nested Subfolders**: For deeply nested folders, maintain the hierarchy but limit to 2 levels in the main index. Deeper structures should have their own index files.
-
-## Required Input
-
-Please provide:
-
-1. Location of the `docs/` directory (default: `./docs`)
-2. Confirmation of write access to `docs/index.md`
-3. Any specific categorization preferences
-4. Any files or directories to exclude from indexing (e.g., `.git`, `node_modules`)
-5. Whether to include hidden files/folders (starting with `.`)
-
-Would you like to proceed with documentation indexing? Please provide the required input above.

package/bmad-core/tasks/kb-mode-interaction.md

@@ -1,75 +0,0 @@
-# KB Mode Interaction Task
-
-## Purpose
-
-Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
-
-## Instructions
-
-When entering KB mode (\*kb-mode), follow these steps:
-
-### 1. Welcome and Guide
-
-Announce entering KB mode with a brief, friendly introduction.
-
-### 2. Present Topic Areas
-
-Offer a concise list of main topic areas the user might want to explore:
-
-**What would you like to know more about?**
-
-1. **Setup & Installation** - Getting started with BMad
-2. **Workflows** - Choosing the right workflow for your project
-3. **Web vs IDE** - When to use each environment
-4. **Agents** - Understanding specialized agents and their roles
-5. **Documents** - PRDs, Architecture, Stories, and more
-6. **Agile Process** - How BMad implements Agile methodologies
-7. **Configuration** - Customizing BMad for your needs
-8. **Best Practices** - Tips for effective BMad usage
-
-Or ask me about anything else related to BMad-Method!
-
-### 3. Respond Contextually
-
-- Wait for user's specific question or topic selection
-- Provide focused, relevant information from the knowledge base
-- Offer to dive deeper or explore related topics
-- Keep responses concise unless user asks for detailed explanations
-
-### 4. Interactive Exploration
-
-- After answering, suggest related topics they might find helpful
-- Maintain conversational flow rather than data dumping
-- Use examples when appropriate
-- Reference specific documentation sections when relevant
-
-### 5. Exit Gracefully
-
-When user is done or wants to exit KB mode:
-
-- Summarize key points discussed if helpful
-- Remind them they can return to KB mode anytime with \*kb-mode
-- Suggest next steps based on what was discussed
-
-## Example Interaction
-
-**User**: \*kb-mode
-
-**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
-
-**What would you like to know more about?**
-
-1. **Setup & Installation** - Getting started with BMad
-2. **Workflows** - Choosing the right workflow for your project
-3. **Web vs IDE** - When to use each environment
-4. **Agents** - Understanding specialized agents and their roles
-5. **Documents** - PRDs, Architecture, Stories, and more
-6. **Agile Process** - How BMad implements Agile methodologies
-7. **Configuration** - Customizing BMad for your needs
-8. **Best Practices** - Tips for effective BMad usage
-
-Or ask me about anything else related to BMad-Method!
-
-**User**: Tell me about workflows
-
-**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]

package/bmad-core/tasks/nfr-assess.md

@@ -1,343 +0,0 @@
-# nfr-assess
-
-Quick NFR validation focused on the core four: security, performance, reliability, maintainability.
-
-## Inputs
-
-```yaml
-required:
-  - story_id: '{epic}.{story}' # e.g., "1.3"
-  - story_path: 'docs/stories/{epic}.{story}.*.md'
-
-optional:
-  - architecture_refs: 'docs/architecture/*.md'
-  - technical_preferences: 'docs/technical-preferences.md'
-  - acceptance_criteria: From story file
-```
-
-## Purpose
-
-Assess non-functional requirements for a story and generate:
-
-1. YAML block for the gate file's `nfr_validation` section
-2. Brief markdown assessment saved to `docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md`
-
-## Process
-
-### 0. Fail-safe for Missing Inputs
-
-If story_path or story file can't be found:
-
-- Still create assessment file with note: "Source story not found"
-- Set all selected NFRs to CONCERNS with notes: "Target unknown / evidence missing"
-- Continue with assessment to provide value
-
-### 1. Elicit Scope
-
-**Interactive mode:** Ask which NFRs to assess
-**Non-interactive mode:** Default to core four (security, performance, reliability, maintainability)
-
-```text
-Which NFRs should I assess? (Enter numbers or press Enter for default)
-[1] Security (default)
-[2] Performance (default)
-[3] Reliability (default)
-[4] Maintainability (default)
-[5] Usability
-[6] Compatibility
-[7] Portability
-[8] Functional Suitability
-
-> [Enter for 1-4]
-```
-
-### 2. Check for Thresholds
-
-Look for NFR requirements in:
-
-- Story acceptance criteria
-- `docs/architecture/*.md` files
-- `docs/technical-preferences.md`
-
-**Interactive mode:** Ask for missing thresholds
-**Non-interactive mode:** Mark as CONCERNS with "Target unknown"
-
-```text
-No performance requirements found. What's your target response time?
-> 200ms for API calls
-
-No security requirements found. Required auth method?
-> JWT with refresh tokens
-```
-
-**Unknown targets policy:** If a target is missing and not provided, mark status as CONCERNS with notes: "Target unknown"
-
-### 3. Quick Assessment
-
-For each selected NFR, check:
-
-- Is there evidence it's implemented?
-- Can we validate it?
-- Are there obvious gaps?
-
-### 4. Generate Outputs
-
-## Output 1: Gate YAML Block
-
-Generate ONLY for NFRs actually assessed (no placeholders):
-
-```yaml
-# Gate YAML (copy/paste):
-nfr_validation:
-  _assessed: [security, performance, reliability, maintainability]
-  security:
-    status: CONCERNS
-    notes: 'No rate limiting on auth endpoints'
-  performance:
-    status: PASS
-    notes: 'Response times < 200ms verified'
-  reliability:
-    status: PASS
-    notes: 'Error handling and retries implemented'
-  maintainability:
-    status: CONCERNS
-    notes: 'Test coverage at 65%, target is 80%'
-```
-
-## Deterministic Status Rules
-
-- **FAIL**: Any selected NFR has critical gap or target clearly not met
-- **CONCERNS**: No FAILs, but any NFR is unknown/partial/missing evidence
-- **PASS**: All selected NFRs meet targets with evidence
-
-## Quality Score Calculation
-
-```
-quality_score = 100
-- 20 for each FAIL attribute
-- 10 for each CONCERNS attribute
-Floor at 0, ceiling at 100
-```
-
-If `technical-preferences.md` defines custom weights, use those instead.
-
-## Output 2: Brief Assessment Report
-
-**ALWAYS save to:** `docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md`
-
-```markdown
-# NFR Assessment: {epic}.{story}
-
-Date: {date}
-Reviewer: Quinn
-
-<!-- Note: Source story not found (if applicable) -->
-
-## Summary
-
-- Security: CONCERNS - Missing rate limiting
-- Performance: PASS - Meets <200ms requirement
-- Reliability: PASS - Proper error handling
-- Maintainability: CONCERNS - Test coverage below target
-
-## Critical Issues
-
-1. **No rate limiting** (Security)
-   - Risk: Brute force attacks possible
-   - Fix: Add rate limiting middleware to auth endpoints
-
-2. **Test coverage 65%** (Maintainability)
-   - Risk: Untested code paths
-   - Fix: Add tests for uncovered branches
-
-## Quick Wins
-
-- Add rate limiting: ~2 hours
-- Increase test coverage: ~4 hours
-- Add performance monitoring: ~1 hour
-```
-
-## Output 3: Story Update Line
-
-**End with this line for the review task to quote:**
-
-```
-NFR assessment: docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
-```
-
-## Output 4: Gate Integration Line
-
-**Always print at the end:**
-
-```
-Gate NFR block ready → paste into docs/qa/gates/{epic}.{story}-{slug}.yml under nfr_validation
-```
-
-## Assessment Criteria
-
-### Security
-
-**PASS if:**
-
-- Authentication implemented
-- Authorization enforced
-- Input validation present
-- No hardcoded secrets
-
-**CONCERNS if:**
-
-- Missing rate limiting
-- Weak encryption
-- Incomplete authorization
-
-**FAIL if:**
-
-- No authentication
-- Hardcoded credentials
-- SQL injection vulnerabilities
-
-### Performance
-
-**PASS if:**
-
-- Meets response time targets
-- No obvious bottlenecks
-- Reasonable resource usage
-
-**CONCERNS if:**
-
-- Close to limits
-- Missing indexes
-- No caching strategy
-
-**FAIL if:**
-
-- Exceeds response time limits
-- Memory leaks
-- Unoptimized queries
-
-### Reliability
-
-**PASS if:**
-
-- Error handling present
-- Graceful degradation
-- Retry logic where needed
-
-**CONCERNS if:**
-
-- Some error cases unhandled
-- No circuit breakers
-- Missing health checks
-
-**FAIL if:**
-
-- No error handling
-- Crashes on errors
-- No recovery mechanisms
-
-### Maintainability
-
-**PASS if:**
-
-- Test coverage meets target
-- Code well-structured
-- Documentation present
-
-**CONCERNS if:**
-
-- Test coverage below target
-- Some code duplication
-- Missing documentation
-
-**FAIL if:**
-
-- No tests
-- Highly coupled code
-- No documentation
-
-## Quick Reference
-
-### What to Check
-
-```yaml
-security:
-  - Authentication mechanism
-  - Authorization checks
-  - Input validation
-  - Secret management
-  - Rate limiting
-
-performance:
-  - Response times
-  - Database queries
-  - Caching usage
-  - Resource consumption
-
-reliability:
-  - Error handling
-  - Retry logic
-  - Circuit breakers
-  - Health checks
-  - Logging
-
-maintainability:
-  - Test coverage
-  - Code structure
-  - Documentation
-  - Dependencies
-```
-
-## Key Principles
-
-- Focus on the core four NFRs by default
-- Quick assessment, not deep analysis
-- Gate-ready output format
-- Brief, actionable findings
-- Skip what doesn't apply
-- Deterministic status rules for consistency
-- Unknown targets → CONCERNS, not guesses
-
----
-
-## Appendix: ISO 25010 Reference
-
-<details>
-<summary>Full ISO 25010 Quality Model (click to expand)</summary>
-
-### All 8 Quality Characteristics
-
-1. **Functional Suitability**: Completeness, correctness, appropriateness
-2. **Performance Efficiency**: Time behavior, resource use, capacity
-3. **Compatibility**: Co-existence, interoperability
-4. **Usability**: Learnability, operability, accessibility
-5. **Reliability**: Maturity, availability, fault tolerance
-6. **Security**: Confidentiality, integrity, authenticity
-7. **Maintainability**: Modularity, reusability, testability
-8. **Portability**: Adaptability, installability
-
-Use these when assessing beyond the core four.
-
-</details>
-
-<details>
-<summary>Example: Deep Performance Analysis (click to expand)</summary>
-
-```yaml
-performance_deep_dive:
-  response_times:
-    p50: 45ms
-    p95: 180ms
-    p99: 350ms
-  database:
-    slow_queries: 2
-    missing_indexes: ['users.email', 'orders.user_id']
-  caching:
-    hit_rate: 0%
-    recommendation: 'Add Redis for session data'
-  load_test:
-    max_rps: 150
-    breaking_point: 200 rps
-```
-
-</details>