docs: massive documentation overhaul + introduce Paige (Documentation Guide agent)

## 📚 Complete Documentation Restructure

**BMM Documentation Hub Created:**
- New centralized documentation system at `src/modules/bmm/docs/`
- 18 comprehensive guides organized by topic (7000+ lines total)
- Clear learning paths for greenfield, brownfield, and quick spec flows
- Professional technical writing standards throughout

**New Documentation:**
- `README.md` - Complete documentation hub with navigation
- `quick-start.md` - 15-minute getting started guide
- `agents-guide.md` - Comprehensive 12-agent reference (45 min read)
- `party-mode.md` - Multi-agent collaboration guide (20 min read)
- `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read)
- `brownfield-guide.md` - Existing codebase development (53 min read)
- `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read)
- `workflows-analysis.md` - Phase 1 workflows (12 min read)
- `workflows-planning.md` - Phase 2 workflows (19 min read)
- `workflows-solutioning.md` - Phase 3 workflows (13 min read)
- `workflows-implementation.md` - Phase 4 workflows (33 min read)
- `workflows-testing.md` - Testing & QA workflows (29 min read)
- `workflow-architecture-reference.md` - Architecture workflow deep-dive
- `workflow-document-project-reference.md` - Document-project workflow reference
- `enterprise-agentic-development.md` - Team collaboration patterns
- `faq.md` - Comprehensive Q&A covering all topics
- `glossary.md` - Complete terminology reference
- `troubleshooting.md` - Common issues and solutions

**Documentation Improvements:**
- Removed all version/date footers (git handles versioning)
- Agent customization docs now include full rebuild process
- Cross-referenced links between all guides
- Reading time estimates for all major docs
- Consistent professional formatting and structure

**Consolidated & Streamlined:**
- Module README (`src/modules/bmm/README.md`) streamlined to lean signpost
- Root README polished with better hierarchy and clear CTAs
- Moved docs from root `docs/` to module-specific locations
- Better separation of user docs vs. developer reference

## 🤖 New Agent: Paige (Documentation Guide)

**Role:** Technical documentation specialist and information architect

**Expertise:**
- Professional technical writing standards
- Documentation structure and organization
- Information architecture and navigation
- User-focused content design
- Style guide enforcement

**Status:** Work in progress - Paige will evolve as documentation needs grow

**Integration:**
- Listed in agents-guide.md, glossary.md, FAQ
- Available for all phases (documentation is continuous)
- Can be customized like all BMM agents

## 🔧 Additional Changes

- Updated agent manifest with Paige
- Updated workflow manifest with new documentation workflows
- Fixed workflow-to-agent mappings across all guides
- Improved root README with clearer Quick Start section
- Better module structure explanations
- Enhanced community links with Discord channel names

**Total Impact:**
- 18 new/restructured documentation files
- 7000+ lines of professional technical documentation
- Complete navigation system with cross-references
- Clear learning paths for all user types
- Foundation for knowledge base (coming in beta)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Brian Madison
2025-11-02 21:18:33 -06:00
parent 8a00f8ad70
commit cfedecbd53
359 changed files with 72374 additions and 809 deletions

View File

@@ -0,0 +1,195 @@
# {{game_name}} - Narrative Design Document
**Author:** {{user_name}}
**Game Type:** {{game_type}}
**Narrative Complexity:** {{narrative_complexity}}
---
## Executive Summary
### Narrative Premise
{{narrative_premise}}
### Core Themes
{{core_themes}}
### Tone and Atmosphere
{{tone_atmosphere}}
---
## Story Structure
### Story Type
{{story_type}}
**Structure used:** (3-act, hero's journey, kishōtenketsu, episodic, branching, etc.)
### Act Breakdown
{{act_breakdown}}
### Story Beats
{{story_beats}}
### Pacing and Flow
{{pacing_flow}}
---
## Characters
### Protagonist(s)
{{protagonists}}
### Antagonist(s)
{{antagonists}}
### Supporting Characters
{{supporting_characters}}
### Character Arcs
{{character_arcs}}
---
## World and Lore
### World Overview
{{world_overview}}
### History and Backstory
{{history_backstory}}
### Factions and Organizations
{{factions_organizations}}
### Locations
{{locations}}
### Cultural Elements
{{cultural_elements}}
---
## Dialogue Framework
### Dialogue Style
{{dialogue_style}}
### Key Conversations
{{key_conversations}}
### Branching Dialogue
{{branching_dialogue}}
### Voice and Characterization
{{voice_characterization}}
---
## Environmental Storytelling
### Visual Storytelling
{{visual_storytelling}}
### Audio Storytelling
{{audio_storytelling}}
### Found Documents
{{found_documents}}
### Environmental Clues
{{environmental_clues}}
---
## Narrative Delivery
### Cutscenes and Cinematics
{{cutscenes}}
### In-Game Storytelling
{{ingame_storytelling}}
### Optional Content
{{optional_content}}
### Multiple Endings
{{multiple_endings}}
---
## Integration with Gameplay
### Narrative-Gameplay Harmony
{{narrative_gameplay}}
### Story Gates
{{story_gates}}
### Player Agency
{{player_agency}}
---
## Production Notes
### Writing Scope
{{writing_scope}}
### Localization Considerations
{{localization}}
### Voice Acting
{{voice_acting}}
---
## Appendix
### Character Relationship Map
{{relationship_map}}
### Timeline
{{timeline}}
### References and Inspirations
{{references}}