Markdown Report Formatting
Status reports, project updates, documentation
Recognition
- "status report", "project update", "weekly summary", "documentation"
- Output will be read in markdown renderer (GitHub, Notion, etc.)
- Needs sections, tables, metrics, action items
Structure
# [Report Title]
**Project:** [Name] | **Date:** [Month Day, Year] | **Status:** [On Track / At Risk / Blocked]
---
## Executive Summary
[1-2 sentences: what happened, what's next]
---
## Key Accomplishments
- [Achievement with metric]: [brief context]
- [Achievement with metric]: [brief context]
---
## Current Priorities
### 1. [Priority Name]
**Owner:** [Team/Person] | **Due:** [Date] | **Status:** [In Progress / On Track / Not Started]
[1-2 sentences of context]
---
## Blockers & Risks
| Issue | Impact | Mitigation | Owner |
| --------- | --------------- | ---------- | ------ |
| [Problem] | High/Medium/Low | [Action] | [Name] |
---
## Action Items
- [ ] **@[person]** - [task] by [date]
- [ ] **@[person]** - [task] by [date]
---
**Next Update:** [Date]
Rules
| Element | Format |
|---|---|
| Headers | ## for sections, ### for subsections |
| Status badges | On Track / At Risk / Blocked (choose one) |
| Dates | Spelled month: "December 4, 2024" |
| Metrics | Bold the number: "23% increase" |
| Tables | For blockers, comparisons, multi-column data |
| Action items | Checkbox + bold @mention + task + date |
| Separators | --- between major sections |
Pitfalls
- Walls of text without headers (break every 2-3 paragraphs)
- Missing metrics (quantify: "improved performance" → "40% faster")
- Vague action items (need: who + what + when)
- Status without context (why is it blocked? what's the mitigation?)
## Recognition
- "status report", "project update", "weekly summary", "documentation"
- Output will be read in markdown renderer (GitHub, Notion, etc.)
- Needs sections, tables, metrics, action items
## Structure
```markdown
# [Report Title]
**Project:** [Name] | **Date:** [Month Day, Year] | **Status:** [On Track / At Risk / Blocked]
---
## Executive Summary
[1-2 sentences: what happened, what's next]
---
## Key Accomplishments
- [Achievement with metric]: [brief context]
- [Achievement with metric]: [brief context]
---
## Current Priorities
### 1. [Priority Name]
**Owner:** [Team/Person] | **Due:** [Date] | **Status:** [In Progress / On Track / Not Started]
[1-2 sentences of context]
---
## Blockers & Risks
| Issue | Impact | Mitigation | Owner |
| --------- | --------------- | ---------- | ------ |
| [Problem] | High/Medium/Low | [Action] | [Name] |
---
## Action Items
- [ ] **@[person]** - [task] by [date]
- [ ] **@[person]** - [task] by [date]
---
**Next Update:** [Date]
```
## Rules
| Element | Format |
| ------------- | -------------------------------------------- |
| Headers | `##` for sections, `###` for subsections |
| Status badges | On Track / At Risk / Blocked (choose one) |
| Dates | Spelled month: "December 4, 2024" |
| Metrics | Bold the number: "**23%** increase" |
| Tables | For blockers, comparisons, multi-column data |
| Action items | Checkbox + bold @mention + task + date |
| Separators | `---` between major sections |
## Pitfalls
- Walls of text without headers (break every 2-3 paragraphs)
- Missing metrics (quantify: "improved performance" → "**40%** faster")
- Vague action items (need: who + what + when)
- Status without context (why is it blocked? what's the mitigation?)