Phase Template Quick Reference

Quick reference card for AI agents creating phase documentation

📋 Phase Template Quick Reference

For AI Agents: Use this as a cheat sheet when creating phase documentation.

🤖 Automated Creation (RECOMMENDED)

cd /docs/english/Templates/phases-template/
./create-phase.sh <phase-number> <project-path> "<phase-name>"

Time: 30 seconds
Result: Complete phase structure with all templates, context folder, and customized dates!

🎯 Required Files (5 Total + context folder)

File	Extension	Purpose	Update Frequency
`index.mdc`	`.mdc`	Phase overview	When status changes
`PHASE-X-COMPLETE-PLAN.md`	`.md`	Implementation plan	Rarely (reference)
`achievements.md`	`.md`	Feature tracking	After milestones
`progress.md`	`.md`	Daily notes	Every session
`next-steps.md`	`.md`	Action items	Daily
`context/`	`folder`	Historical docs	End of phase

⚠️ CRITICAL: Always create the context/ folder and READ IT FIRST when continuing work!

📝 Naming Rules

Files

✅ Correct:

index.mdc (lowercase, .mdc)
PHASE-9-COMPLETE-PLAN.md (ALL CAPS with hyphens)
achievements.md (lowercase, descriptive)
progress.md (lowercase)
next-steps.md (lowercase with hyphen)

❌ Incorrect:

Index.mdc (wrong capitalization)
Phase-9-Plan.md (inconsistent caps)
next_steps.md (underscore instead of hyphen)

Progress Notes (Special Case)

📝 Active Work: PROGRESS_NOTE_NOV_10.md (ALL CAPS, underscores)
✅ Final/Complete: final-session-notes.md (kebab-case)

🔖 Frontmatter Template

---
title: [Descriptive Title]
description: [One sentence description]
icon: [Emoji]
created: [Month Day, Year]
updated: [Month Day, Year] [Time]
status: [STATUS]
purpose: [Detailed purpose]
order: [Number]
tags: [phase-X, tag2, tag3]
---

Common Status Values

🎯 PLANNED - Not started
🚀 IN PROGRESS - Active work
✅ COMPLETE - Finished
⏳ PENDING - Waiting
🔴 BLOCKED - Cannot proceed
📝 TRACKING - Ongoing documentation

Common Icons

🎯 - Phase overview
📝 - Progress/notes
🏆 - Achievements
⏭️ - Next steps
📋 - Plans/checklists

🎨 Status Indicators

Priority Levels

🔴 CRITICAL - Blocks progress, fix immediately
🟡 HIGH     - Important, do soon
🟢 MEDIUM   - Nice to have, can wait
⚪ LOW      - Optional, future

Task Status

✅ Done
🚀 In Progress
⏳ Pending
🔴 Blocked
📝 Tracking

📊 Progress Bar Format

Feature Name         [████████░░] 80% (8/10 hours)

Pattern: [TaskName] [ProgressBar] [Percent] ([Completed]/[Total] hours)

🔗 Link Format

Internal Links

✅ Correct: [Link Text](/path/to/page) ❌ Wrong: [Link Text](/path/to/page.md) ❌ Wrong: [Link Text](/english/path/to/page)

Relative vs Absolute

Same directory: ./file.md or [text](./file)
Parent directory: ../phase-Y/file.md
Absolute: /GoGrab-Space/user-journey/phases/phase-X/file

Rule: Use absolute paths without extensions for documentation links.

📅 Date Format

Frontmatter

created: November 10, 2025
updated: November 10, 2025 10:30 AM

Content

**Updated**: November 10, 2025 10:30 AM
**Phase Start**: November 10, 2025

Rule: Always include time for "updated" fields.

🎯 When to Create New Phase

Create new phase when:

✅ Major milestone reached
✅ Scope shift needed
✅ Current phase > 50 hours
✅ Natural breakpoint reached

Don't create new phase for:

❌ Minor bug fixes
❌ Small features
❌ Ongoing maintenance

🔄 AI Agent Workflow

Starting Phase (Automated Method - RECOMMENDED)

READ context/ folder FIRST ⚠️ CRITICAL

Run automation script:

cd /docs/english/Templates/phases-template/
./create-phase.sh 10 Project/path "Phase Name"

Customize remaining placeholders in generated files
Done! Start working on phase

Starting Phase (Manual Method - Not Recommended)

Click to expand manual steps

READ context/ folder FIRST ⚠️ CRITICAL
Create folder: phase-X/ and phase-X/context/
Copy all 5 templates from /Templates/phases-template/
Fill in frontmatter
Customize content
Create Day 0 progress entry
Run yarn docs:scan

###During Phase

Check context/ for previous decisions
Update progress.md after every session
Update achievements.md when milestones complete
Update next-steps.md daily
Update index.mdc when status changes

Completing Phase

Mark all as ✅ COMPLETE
Move important docs to context/ folder
Final timestamps
Create completion summary
Plan next phase
Run yarn docs:scan

📚 Code Block Syntax

TypeScript

```typescript
function example(): void {
  // code here
}
```

Bash

```bash
npm install
yarn build
```

YAML

```yaml
key: value
nested:
  - item1
  - item2
```

✅ Pre-Flight Checklist

Before marking phase complete:

Files

All 5 required files present
Naming conventions followed
Frontmatter complete

Content

Dates/times accurate
Links work (no 404s)
Code blocks formatted
Status indicators correct

Documentation

Ran yarn docs:scan
Phase appears in nav
Parent index updated
Links to previous phase

🚨 Common Mistakes

❌ Don't Do This

## 🧩 **SECTION TITLE**  ← Too complex
[Link](/path/to/file.md)  ← Has .md extension
updated: Nov 10  ← Missing time

✅ Do This Instead

## Section Title  ← Simple
[Link](/path/to/file)  ← No extension
updated: November 10, 2025 10:30 AM  ← Complete

📖 Template Locations

All templates in:

/docs/english/Templates/phases-template/
├── README.md (complete guide)
├── index.template.mdc
├── PHASE-X-COMPLETE-PLAN.template.md
├── achievements.template.md
├── progress.template.md
├── next-steps.template.md
└── QUICK-REFERENCE.md (this file)

Phase Structure:

phase-X/
├── index.mdc
├── PHASE-X-COMPLETE-PLAN.md
├── achievements.md
├── progress.md
├── next-steps.md
└── context/                    ⬅️ IMPORTANT!
    ├── COMPLETE-INTEGRATION-STATUS-*.md
    ├── FINAL-SESSION-REPORT-*.md
    ├── HONEST-STATUS-ASSESSMENT-*.md
    └── [Other historical docs]

🎓 Learning Resources

Full Guide: README.md
Workflow: AI-AGENT-WORKFLOW.md
Visual Guide: VISUAL-SUMMARY.md
Example with Context: Universe Restructure Phase 1
Example Phases: Phase 8 | Phase 9

Template Location: /docs/english/Templates/phases-template/
Last Updated: November 10, 2025
Version: 1.1 (Added context folder support)
Status: ✅ READY FOR USE