Phase Documentation Templates

Complete templates and guides for AI agents creating phase documentation

📦 Phase Documentation Templates

Complete template system for AI agents to create consistent, high-quality phase documentation.

Template Location: /docs/english/Templates/phases-template/
Version: 1.1 (Added context folder support)

🎯 What This Is

This folder contains everything an AI agent needs to create perfect phase documentation for any project. It includes:

  1. Templates - Copy-paste ready files for all phase documentation
  2. Guides - Step-by-step instructions for using templates
  3. References - Quick lookup for common patterns
  4. Examples - Real phases demonstrating best practices
  5. Context Folder Pattern - How to preserve historical documentation

⚠️ CRITICAL: Context Folder

Every phase MUST have a context/ subfolder!

Why Context Matters

AI agents should ALWAYS read the context folder FIRST before continuing work. This folder contains:

Example Context Folder

See Universe Restructure Phase 1 for an excellent example of a context folder with:

📚 Available Resources

🚀 Get Started Here

New to phase documentation?
Start with: AI Agent Workflow Guide

Need quick reference?
Use: Quick Reference Card

Want comprehensive guide?
Read: Complete README

📝 Template Files

All templates are ready to copy and customize:

1. index.mdc.template

Purpose: Phase overview and navigation hub
Update: When status changes
View Template →

2. PHASE-X-COMPLETE-PLAN.md.template

Purpose: Comprehensive technical roadmap
Update: Rarely (reference document)
View Template →

3. achievements.md.template

Purpose: Feature completion tracking
Update: After milestones complete
View Template →

4. progress.md.template

Purpose: Daily progress notes
Update: Every work session
View Template →

5. next-steps.md.template

Purpose: Immediate action items
Update: Daily
View Template →

🎓 Documentation Guides

For AI Agents

Guide Purpose Time to Read
AI Agent Workflow Step-by-step phase creation 10 min
Quick Reference Cheat sheet for common patterns 3 min
Complete README Comprehensive documentation 15 min

For Humans

All guides work for humans too! The templates ensure consistency regardless of who (or what) creates the documentation.

🌟 Example Phases

Learn by example - see these real phases:

Phase 8: Polish, Real AI & Production Launch

Status: Completed
Focus: Final polish, AI implementation, deployment
View Phase 8 →

Highlights:

Phase 9: Production Perfection & Launch

Status: In Progress
Focus: Flow composition, testing, production deployment
View Phase 9 →

Highlights:

Universe Restructure Phase 1: Integration Complete

Status: Complete
Focus: Module system integration
View Phase 1 →

Highlights:

🚀 Quick Start (30 Seconds!)

For AI Agents - Automated Method ⚡ RECOMMENDED

# Navigate to templates
cd /docs/english/Templates/phases-template/

# Run intelligent automation script
./create-phase.sh <phase-number> <project-path> "<phase-name>"

# Example:
./create-phase.sh 10 GoGrab-Space/user-journey "Production Launch"

The script automatically:

  1. ✅ Reads previous phase context (if exists)
  2. ✅ Creates complete folder structure
  3. ✅ Creates context/ subdirectory with README
  4. ✅ Copies and renames all 5 templates
  5. ✅ Fills in dates, times, phase numbers
  6. ✅ Customizes frontmatter
  7. ✅ Runs yarn docs:scan

Result: Production-ready phase structure in ~30 seconds!

Manual Method (Not Recommended)

Click to expand manual steps

  1. Read context from previous phase FIRST ⚠️

    cd ../phase-[previous]/context/
cat *.md  # Read all context files

  2. Copy templates:

    cd /docs/english/[Project]/phases/
mkdir phase-X
cd phase-X
mkdir context  # Create context folder!
cp /docs/english/Templates/phases-template/*.template.* .

  3. Rename files:

    mv index.template.mdc index.mdc
mv PHASE-X-COMPLETE-PLAN.template.md PHASE-X-COMPLETE-PLAN.md
mv achievements.template.md achievements.md
mv progress.template.md progress.md
mv next-steps.template.md next-steps.md

  4. Customize content:

    • Fill in frontmatter
    • Replace placeholders
    • Add specific details from context

  5. Verify:

    yarn docs:scan

✅ Quality Standards

All phase documentation created from these templates must meet:

Content Standards

Structure Standards

Integration Standards

📊 Template Structure

phases-template/
├── index.mdc                          # This file
├── README.md                          # Comprehensive guide
├── AI-AGENT-WORKFLOW.md               # Step-by-step workflow
├── QUICK-REFERENCE.md                 # Quick lookup
│
├── Templates (copy these):
├── index.mdc.template                 # Phase overview
├── PHASE-X-COMPLETE-PLAN.md.template  # Implementation plan
├── achievements.md.template           # Feature tracking
├── progress.md.template               # Daily notes
└── next-steps.md.template             # Action items

🎯 When to Use Templates

Create New Phase When:

Don't Create New Phase For:

🔄 Template Maintenance

Version History

v1.0 - November 10, 2025

Future Enhancements

Planned improvements:

🆘 Getting Help

Common Issues

Templates not working?

Documentation not appearing?

Need clarification?

🌟 Success Stories

Phases created using these templates:

📖 Related Documentation

🎊 Contributing

Found a way to improve the templates?

  1. Test changes in a real phase
  2. Document the improvement
  3. Update templates
  4. Update guides
  5. Share with team

📋 Checklist for New Templates

When creating/updating templates:

Created: November 10, 2025
Last Updated: November 10, 2025
Version: 1.0
Status: ✅ TEMPLATE SYSTEM READY
Maintained By: AI Agents & Development Team

🚀 Start Creating!

Ready to create your first phase?

  1. Read: AI Agent Workflow
  2. Copy: Template files
  3. Customize: Fill in details
  4. Verify: Run docs:scan
  5. Begin: Start working!

Let's build something amazing! 🌟