← Back to list

phase-summary
by zduanx
⭐ 0🍴 0📅 Jan 22, 2026
SKILL.md
name: phase-summary description: Write or update phase summary documentation. Use when asked to create, write, or update a phase summary, document a phase, or summarize what was built in a phase.
Phase Summary Writing Guide
When writing a phase summary, follow this exact structure with 12 sections.
File Location
Save to: docs/logs/PHASE_{X}_SUMMARY.md (e.g., PHASE_2I_SUMMARY.md)
Required Structure
Header
# Phase X: [Name]
**Status**: ✅ Completed / 📋 Planning / 🚧 In Progress
**Date**: [Month Day, Year] (use actual current date)
**Goal**: [One sentence - why does this phase exist?]
Sections (in order)
- Overview - 2-3 paragraphs + "Included in this phase" + "Explicitly excluded"
- Key Achievements - Numbered list with inline references to ADRs/learning docs
- Database Schema - Only if this phase added/modified schema
- API Endpoints - Only if this phase added new endpoints
- Highlights - Technical details, optimizations, quirks
- Testing & Validation - Split manual vs automated
- Metrics - Tables, counts, measurements
- Next Steps → Phase X+1 - Brief description + key features
- File Structure - Tree diagram + key files with links
- Key Learnings - Brief insights, link to learning docs
- References - External URLs only (internal docs linked inline)
Principles
- Use
---dividers between sections - Keep each item 1-3 bullets
- Inline refs for internal docs, end section for external URLs
- Use actual current date (check system context)
- No time estimates in Next Steps
- Omit sections that don't apply (e.g., no Database Schema if no DB changes)
Example Section
## Key Achievements
### 1. SSE Progress Endpoint
- Real-time streaming via `text/event-stream`
- JWT authentication via query parameter
- Reference: [ADR-016](../architecture/DECISIONS.md#adr-016-sse-for-real-time-progress-updates)
### 2. Frontend EventSource Connection
- React `useEffect` hook manages lifecycle
- Auto-reconnect on API Gateway timeout
Before Writing
- Check recent git commits:
git log --oneline -20 - Review existing phase summaries for style consistency
- Identify key files changed in this phase
Score
Total Score
50/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon