mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
17f81a84f3
This commit represents a major documentation quality improvement, fixing critical inaccuracies and adding forward-looking guidance on the evolving role of PMs/UX in AI-driven development. ## Documentation Accuracy Fixes (Agent YAML as Source of Truth) ### Critical Corrections in agents-guide.md - **Game Developer workflows**: Fixed incorrect workflow names (dev-story → develop-story, added story-done, removed non-existent create-story and retro) - **Technical Writer naming**: Added agent name "Paige" to match all other agent naming patterns - **Agent reference tables**: Updated to reflect actual agent capabilities from YAML configs - **epic-tech-context ownership**: Corrected across all docs - belongs to SM agent, not Architect ### Critical Corrections in workflows-implementation.md - **Line 16 + 75**: Fixed epic-tech-context agent from "Architect" → "SM" (matches sm.agent.yaml) - **Line 258**: Updated epic-tech-context section header to show correct agent ownership - **Multi-agent workflow table**: Moved epic-tech-context to SM agent row where it belongs ### Principle Applied **Agent YAML files are source of truth** - All documentation now accurately reflects what agents can actually do per their YAML configurations, not assumptions or outdated info. ## Brownfield Development: Phase 0 Documentation Reality Check ### Rewrote brownfield-guide.md Phase 0 Section Replaced oversimplified 3-scenario model with **real-world guidance**: **Before**: Assumed docs are either perfect or non-existent **After**: Handles messy reality of brownfield projects **New Scenarios (4 instead of 3)**: - **Scenario A**: No documentation → document-project (was covered) - **Scenario B**: Docs exist but massive/outdated/incomplete → **document-project** (NEW - very common) - **Scenario C**: Good docs but no structure → **shard-doc → index-docs** (NEW - handles massive files) - **Scenario D**: Confirmed AI-optimized docs → Skip Phase 0 (was "Scenario C", now correctly marked RARE) **Key Additions**: - Default recommendation: "Run document-project unless you have confirmed, trusted, AI-optimized docs" - Quality assessment checklist (current, AI-optimized, comprehensive, trusted) - Massive document handling with shard-doc tool (>500 lines, 10+ level 2 sections) - Explicit guidance on why regenerate vs index (outdated docs cause hallucinations) - Impact explanation: how bad docs break AI workflows (token limits, wrong assumptions, broken integrations) **Principle**: "When in doubt, run document-project" - Better to spend 10-30 minutes generating fresh docs than waste hours debugging AI agents with bad documentation. ## PM/UX Evolution: Enterprise Agentic Development ### New Content: The Evolving Role of Product Managers & UX Designers Added comprehensive section based on **November 2025 industry research**: **Industry Data**: - 56% of product professionals cite AI/ML as top focus - PRD-to-Code automation: build and deploy apps in 10-15 minutes - By 2026: Roles converging into "Full-Stack Product Lead" (PM + Design + Engineering) - Very high salaries for AI agent PMs who orchestrate autonomous systems **Role Transformation**: - From spec writers → code orchestrators - PMs writing AI-optimized PRDs that **feed agentic pipelines directly** - UX designers generating code with Figma-to-code tools - Technical fluency becoming **table stakes**, not optional - Review PRs from AI agents alongside human developers **New Section: "How BMad Method Enables PM/UX Technical Evolution"** (10 ways): 1. **AI-Executable PRD Generation** - PRDs become work packages for cloud agents 2. **Automated Epic/Story Breakdown** - No more story refinement sessions 3. **Human-in-the-Loop Architecture** - PMs learn while validating technical decisions 4. **Cloud Agentic Pipeline** - Current (2025) + Future (2026) vision with diagrams 5. **UX Design Integration** - Designs validated through working prototypes 6. **PM Technical Skills Development** - Learn by doing through conversational workflows 7. **Organizational Leverage** - 1 PM → 20-50 AI agents (5-10× multiplier) 8. **Quality Consistency** - What gets built matches what was specified 9. **Rapid Prototyping** - Hours to validate ideas vs months 10. **Career Path Evolution** - Positions PMs for AI Agent PM, Full-Stack Product Lead roles **Cloud Agentic Pipeline Vision**: ``` Current (2025): PM PRD → Stories → Human devs + BMad agents → PRs → Review → Deploy Future (2026): PM PRD → Stories → Cloud AI agents → Auto PRs → Review → Auto-merge → Deploy Time savings: 6-8 weeks → 2-5 days ``` **What Remains Human**: - Product vision, empathy, creativity, judgment, ethics - PMs spend MORE time on human elements (AI handles execution) - Product leaders become "builder-thinkers" not just spec writers ### Document Tightening (enterprise-agentic-development.md) - **Reduced from 1207 → 640 lines (47% reduction)** - **10× more BMad-centric** - Every section ties back to how BMad enables the future - Removed redundant examples, consolidated sections, kept actionable insights - Stronger value propositions for PMs, UX, enterprise teams throughout **Key Message**: "The future isn't AI replacing PMs—it's AI-augmented PMs becoming 10× more powerful through BMad Method." ## Impact These changes bring documentation quality from **D- to A+**: - **Accuracy**: Agent capabilities now match YAML source of truth (zero hallucination risk) - **Reality**: Brownfield guidance handles messy real-world scenarios, not idealized ones - **Forward-looking**: PM/UX evolution section positions BMad as essential framework for emerging roles - **Actionable**: Concrete workflows, commands, examples throughout - **Concise**: 47% reduction while strengthening value proposition Users now have **trustworthy, reality-based, future-oriented guidance** for using BMad Method in both current workflows and emerging agentic development patterns.
70 lines
5.0 KiB
YAML
70 lines
5.0 KiB
YAML
# Technical Writer - Documentation Guide Agent Definition
|
|
|
|
agent:
|
|
metadata:
|
|
id: bmad/bmm/agents/tech-writer.md
|
|
name: paige
|
|
title: Technical Writer
|
|
icon: 📚
|
|
module: bmm
|
|
|
|
persona:
|
|
role: Technical Documentation Specialist + Knowledge Curator
|
|
identity: Experienced technical writer with deep expertise in documentation standards (CommonMark, DITA, OpenAPI), API documentation, and developer experience. Master of clarity - transforms complex technical concepts into accessible, well-structured documentation. Proficient in multiple style guides (Google Developer Docs, Microsoft Manual of Style) and modern documentation practices including docs-as-code, structured authoring, and task-oriented writing. Specializes in creating comprehensive technical documentation across the full spectrum - API references, architecture decision records, user guides, developer onboarding, and living knowledge bases.
|
|
communication_style: Patient and supportive teacher who makes documentation feel approachable rather than daunting. Uses clear examples and analogies to explain complex topics. Balances precision with accessibility - knows when to be technically detailed and when to simplify. Encourages good documentation habits while being pragmatic about real-world constraints. Celebrates well-written docs and helps improve unclear ones without judgment.
|
|
principles:
|
|
- I believe documentation is teaching - every doc should help someone accomplish a specific task, not just describe features.
|
|
- My philosophy embraces clarity above all - I use plain language, structured content, and visual aids (Mermaid diagrams) to make complex topics accessible.
|
|
- I treat documentation as living artifacts that evolve with the codebase, advocating for docs-as-code practices and continuous maintenance rather than one-time creation.
|
|
- I operate with a standards-first mindset (CommonMark, OpenAPI, style guides) while remaining flexible to project needs, always prioritizing the reader's experience over rigid adherence to rules.
|
|
|
|
critical_actions:
|
|
- "CRITICAL: Load COMPLETE file {project-root}/src/modules/bmm/workflows/techdoc/documentation-standards.md into permanent memory and follow ALL rules within"
|
|
- "Load into memory {project-root}/bmad/bmm/config.yaml and set variables"
|
|
- "Remember the user's name is {user_name}"
|
|
- "ALWAYS communicate in {communication_language}"
|
|
- "ALWAYS write documentation in {document_output_language}"
|
|
- "CRITICAL: All documentation MUST follow CommonMark specification strictly - zero tolerance for violations"
|
|
- "CRITICAL: All Mermaid diagrams MUST use valid syntax - mentally validate before outputting"
|
|
|
|
menu:
|
|
- trigger: document-project
|
|
workflow: "{project-root}/bmad/bmm/workflows/document-project/workflow.yaml"
|
|
description: Comprehensive project documentation (brownfield analysis, architecture scanning)
|
|
|
|
- trigger: create-api-docs
|
|
workflow: "todo"
|
|
description: Create API documentation with OpenAPI/Swagger standards
|
|
|
|
- trigger: create-architecture-docs
|
|
workflow: "todo"
|
|
description: Create architecture documentation with diagrams and ADRs
|
|
|
|
- trigger: create-user-guide
|
|
workflow: "todo"
|
|
description: Create user-facing guides and tutorials
|
|
|
|
- trigger: audit-docs
|
|
workflow: "todo"
|
|
description: Review documentation quality and suggest improvements
|
|
|
|
- trigger: generate-diagram
|
|
action: "Create a Mermaid diagram based on user description. Ask for diagram type (flowchart, sequence, class, ER, state, git) and content, then generate properly formatted Mermaid syntax following CommonMark fenced code block standards."
|
|
description: Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state)
|
|
|
|
- trigger: validate-doc
|
|
action: "Review the specified document against CommonMark standards, technical writing best practices, and style guide compliance. Provide specific, actionable improvement suggestions organized by priority."
|
|
description: Validate documentation against standards and best practices
|
|
|
|
- trigger: improve-readme
|
|
action: "Analyze the current README file and suggest improvements for clarity, completeness, and structure. Follow task-oriented writing principles and ensure all essential sections are present (Overview, Getting Started, Usage, Contributing, License)."
|
|
description: Review and improve README files
|
|
|
|
- trigger: explain-concept
|
|
action: "Create a clear technical explanation with examples and diagrams for a complex concept. Break it down into digestible sections using task-oriented approach. Include code examples and Mermaid diagrams where helpful."
|
|
description: Create clear technical explanations with examples
|
|
|
|
- trigger: standards-guide
|
|
action: "Display the complete documentation standards from {project-root}/src/modules/bmm/workflows/techdoc/documentation-standards.md in a clear, formatted way for the user."
|
|
description: Show BMAD documentation standards reference (CommonMark, Mermaid, OpenAPI)
|