Skip to content

Commit 1549a6e

Browse files
committed
docs: reject Epic 17, add lightweight incident format to DEVLOG
Epic 17 REJECTED as scope creep (210-line template, SEV-1-5, verification framework for solo project). Replaced by lightweight incident entry format in DEVLOG template with 🚨 INCIDENT prefix, 6-item rubric, structured root-cause/prevention/detection fields (~80-120 tokens vs 210-line template). PRD: v0.9 - Epic 17 rejected, added to Rejected Ideas section. DEVLOG template: incident format, rubric, naming convention, AI guidance. AI rules: incident format + token estimate added to augment + claude-code. Files: project/specs/prd.md, product/templates/DEVLOG_template.md, product/ai-rules/augment/log-file-maintenance.md, product/ai-rules/claude-code/log-file-maintenance.md, logs/CHANGELOG.md
1 parent 57a1333 commit 1549a6e

File tree

5 files changed

+75
-11
lines changed

5 files changed

+75
-11
lines changed

logs/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2828
- Project navigation guide for autonomous agents - Created `project/README.md` explaining directory structure, source of truth hierarchy, and what files to reference. Files: `project/README.md`. Commit: `9ebb777`
2929

3030
- PRD v0.8 alignment pass: Updated Goals (session continuity, self-regulating budgets, minimal dependencies), Background (trimmed), Current State (Feb 2026, resolved issues removed), Technical Assumptions (fixed zero-deps, Augment-only language, manual-only testing), Next Steps (priority order). Files: `project/specs/prd.md`. Commit: `3801f2a`
31+
- PRD v0.9: Epic 17 REJECTED (scope creep). Lightweight incident format added to DEVLOG template with `🚨 INCIDENT` prefix, 6-item rubric, structured root-cause/prevention fields. Incident format added to both AI rule files. Files: `project/specs/prd.md`, `product/templates/DEVLOG_template.md`, `product/ai-rules/augment/log-file-maintenance.md`, `product/ai-rules/claude-code/log-file-maintenance.md`. Commit: `f6ab74a`
3132
- Epic spec status updates: EPIC-12 → In Progress (Partial), EPIC-13 → In Progress (Partial), EPIC-15 → DEFERRED. DEFINITION-OF-DONE.md fixed broken ROADMAP link, noted Epic 15 deferral. Files: `project/specs/EPIC-12-security-secrets-detection.md`, `project/specs/EPIC-13-validation-reliability.md`, `project/specs/EPIC-15-governance-review.md`, `project/specs/DEFINITION-OF-DONE.md`. Commit: `e719d03`
3233

3334
### Changed

product/ai-rules/augment/log-file-maintenance.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ This rule is ALWAYS active. Violations require immediate self-correction.
116116
- 1 paragraph (~320 chars) ≈ 80 tokens
117117
- 1 CHANGELOG entry ≈ 60-80 tokens
118118
- 1 DEVLOG compact entry ≈ 50-80 tokens
119+
- 1 DEVLOG incident entry ≈ 80-120 tokens
119120
- 1 DEVLOG standard entry ≈ 150-250 tokens
120121

121122
**Budgets:**
@@ -129,7 +130,7 @@ This rule is ALWAYS active. Violations require immediate self-correction.
129130

130131
## ✏️ ENTRY VERBOSITY
131132

132-
**Two DEVLOG entry formats:**
133+
**Three DEVLOG entry formats:**
133134

134135
**Compact format** (default for routine work, ~50-80 tokens):
135136
```
@@ -138,7 +139,18 @@ Why/what in 1-2 sentences. Context or rationale.
138139
Files: `file1.py`, `file2.py`
139140
```
140141

141-
**Standard format** (for major decisions, incidents, milestones, ~150-250 tokens):
142+
**Incident format** (for failures worth learning from, ~80-120 tokens):
143+
```
144+
### YYYY-MM-DD: 🚨 INCIDENT - What failed
145+
**Root Cause:** Why it happened (1-2 sentences)
146+
**Prevention:** How to stop it recurring (1-2 actions)
147+
**Detection:** How to catch it earlier next time (1 action)
148+
Files: `file1.py`, `file2.py` → CHANGELOG: `v1.2.1`
149+
```
150+
151+
**Incident rubric — always qualifies:** security exposure, data loss/corruption, repeated failure (3+), silent failure, rule violation with impact, regression.
152+
153+
**Standard format** (for major decisions, milestones, ~150-250 tokens):
142154
```
143155
### YYYY-MM-DD: Title
144156
**The Situation:** ...
@@ -147,7 +159,7 @@ Files: `file1.py`, `file2.py`
147159
**Files Changed:** ...
148160
```
149161

150-
**Decision guide:** If it needs an ADR → use standard. Otherwise → compact.
162+
**Decision guide:** Security/data/regression → incident. Needs an ADR → standard. Everything else → compact.
151163

152164
---
153165

product/ai-rules/claude-code/log-file-maintenance.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ This rule is ALWAYS active. Violations require immediate self-correction.
116116
- 1 paragraph (~320 chars) ≈ 80 tokens
117117
- 1 CHANGELOG entry ≈ 60-80 tokens
118118
- 1 DEVLOG compact entry ≈ 50-80 tokens
119+
- 1 DEVLOG incident entry ≈ 80-120 tokens
119120
- 1 DEVLOG standard entry ≈ 150-250 tokens
120121

121122
**Budgets:**
@@ -129,7 +130,7 @@ This rule is ALWAYS active. Violations require immediate self-correction.
129130

130131
## ✏️ ENTRY VERBOSITY
131132

132-
**Two DEVLOG entry formats:**
133+
**Three DEVLOG entry formats:**
133134

134135
**Compact format** (default for routine work, ~50-80 tokens):
135136
```
@@ -138,7 +139,18 @@ Why/what in 1-2 sentences. Context or rationale.
138139
Files: `file1.py`, `file2.py`
139140
```
140141

141-
**Standard format** (for major decisions, incidents, milestones, ~150-250 tokens):
142+
**Incident format** (for failures worth learning from, ~80-120 tokens):
143+
```
144+
### YYYY-MM-DD: 🚨 INCIDENT - What failed
145+
**Root Cause:** Why it happened (1-2 sentences)
146+
**Prevention:** How to stop it recurring (1-2 actions)
147+
**Detection:** How to catch it earlier next time (1 action)
148+
Files: `file1.py`, `file2.py` → CHANGELOG: `v1.2.1`
149+
```
150+
151+
**Incident rubric — always qualifies:** security exposure, data loss/corruption, repeated failure (3+), silent failure, rule violation with impact, regression.
152+
153+
**Standard format** (for major decisions, milestones, ~150-250 tokens):
142154
```
143155
### YYYY-MM-DD: Title
144156
**The Situation:** ...
@@ -147,7 +159,7 @@ Files: `file1.py`, `file2.py`
147159
**Files Changed:** ...
148160
```
149161

150-
**Decision guide:** If it needs an ADR → use standard. Otherwise → compact.
162+
**Decision guide:** Security/data/regression → incident. Needs an ADR → standard. Everything else → compact.
151163

152164
---
153165

product/templates/DEVLOG_template.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Why/what in 1-2 sentences. Context or rationale.
115115
Files: `file1.py`, `file2.py`
116116
```
117117

118-
**Standard format** (for major decisions, incidents, milestones, ~150-250 tokens):
118+
**Standard format** (for major decisions, milestones, ~150-250 tokens):
119119

120120
```markdown
121121
### YYYY-MM-DD: Title - The Core Theme
@@ -129,7 +129,28 @@ Files: `file1.py`, `file2.py`
129129
**Files Changed:** `file1.py`, `file2.py`
130130
```
131131

132-
**Decision guide:** If it needs an ADR → use standard. Otherwise → compact.
132+
**Incident format** (for failures worth learning from, ~80-120 tokens):
133+
134+
```markdown
135+
### YYYY-MM-DD: 🚨 INCIDENT - Short description of what failed
136+
137+
**Root Cause:** Why it happened (1-2 sentences)
138+
**Prevention:** How to stop it recurring (1-2 actions)
139+
**Detection:** How to catch it earlier next time (1 action)
140+
Files: `file1.py`, `file2.py` → CHANGELOG: `v1.2.1`
141+
```
142+
143+
**Incident rubric — always qualifies:**
144+
1. **Security exposure** — secrets, credentials, or PII leaked or nearly leaked
145+
2. **Data loss or corruption** — user data, log history, or config destroyed
146+
3. **Repeated failure** — same error occurs 3+ times across sessions
147+
4. **Silent failure** — something broke but no error was raised or detected
148+
5. **Rule violation with impact** — AI skipped a required step and it caused downstream problems
149+
6. **Regression** — a previously working feature broke due to a change
150+
151+
> **For AI Agents:** Use the `🚨 INCIDENT` prefix so incidents are findable by text search. Not every bug is an incident — only failures where root-cause analysis prevents recurrence. When in doubt, use compact format with a note instead.
152+
153+
**Decision guide:** Security/data/regression → incident. Needs an ADR → standard. Everything else → compact.
133154

134155
### Best Practices for AI Efficiency
135156

project/specs/prd.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ AI coding assistants struggle when project context grows large — traditional d
5252
| 2026-02-01 | 0.6 | Added Epics 12/13/17/19 to Epic List. Deferred Epic 15, rejected Epic 18. Aligned all epics with mission. | Augment Agent |
5353
| 2026-02-06 | 0.7 | Epic 10 revised: dedicated subagents → agent-agnostic multi-agent support. SESSION END guard for agent teams. | Augment Agent |
5454
| 2026-02-06 | 0.8 | PRD alignment pass: updated Goals, Background, Current State (Feb 2026), Technical Assumptions, Next Steps. Fixed stale claims and Augment-only language. | Augment Agent |
55+
| 2026-02-06 | 0.9 | Epic 17 REJECTED (scope creep). Incident reporting replaced by lightweight DEVLOG incident format with rubric and `🚨 INCIDENT` prefix. | Augment Agent |
5556

5657
---
5758

@@ -156,9 +157,9 @@ No runtime services. The core system is markdown files and AI rules. Optional Py
156157
**Goal:** Verify AI agents maintain logs correctly with automated validation and self-assessment.
157158
**Status:** Planned. Spec: `project/specs/EPIC-13-validation-reliability.md`
158159

159-
### Epic 17: Incident Reports & Learning 📋 P1
160-
**Goal:** Teach AI agents to create structured incident reports when failures occur - documenting what went wrong and how to prevent recurrence.
161-
**Status:** Planned. Template WIP in `project/templates/`. Spec: `project/specs/EPIC-17-incident-reports-learning.md`
160+
### ~~Epic 17: Incident Reports & Learning~~ ❌ REJECTED → DEVLOG Enhancement
161+
**Goal:** ~~Standalone incident report document type with 210-line template, severity levels, verification framework.~~
162+
**Status:** REJECTED - Scope creep (enterprise incident management for solo project). Replaced by lightweight incident entry format in DEVLOG template. See DEVLOG template → "Incident format". Spec: `project/specs/EPIC-17-incident-reports-learning.md`
162163

163164
### ~~Epic 15: Governance & Review~~ ⏸️ DEFERRED
164165
**Goal:** ~~Human review workflows for AI-generated documentation.~~
@@ -1501,6 +1502,23 @@ The following epics were rejected after code-police review identified 60% missio
15011502

15021503
**What Would Be Lost:** Automatic CHANGELOG entries, CI token budget checks. Alternative: AI writes rich content directly (current approach works), validation scripts already provide budget checks.
15031504

1505+
### ~~Epic 17: Incident Reports & Learning~~ ❌ REJECTED → DEVLOG Enhancement
1506+
1507+
**Why Rejected:** Standalone incident report document type (210-line template, SEV-1 through SEV-5, verification framework, metrics dashboards) is enterprise scope creep for a solo project. Information duplicates what DEVLOG and CHANGELOG already capture. Adds a 6th document type that breaks schema consistency (no frontmatter linking, no AI guidance, no archive strategy, Related Documents at bottom not top).
1508+
1509+
**Original Goal:** Structured incident reporting system with template, how-to guide, AI auto-detection, verification framework, and metrics tracking.
1510+
1511+
**Mission Alignment Score:** 4/10 - The *concept* of learning from failures helps AI agents, but the *implementation* wastes tokens (210-line template vs 20-line DEVLOG format) and fragments knowledge across a new document type.
1512+
1513+
**Code-Police Findings:**
1514+
- DEVLOG "Fixed" entries + CHANGELOG "Fixed" entries already capture incident information
1515+
- 8-section template creates navigation overhead that hurts AI token efficiency
1516+
- Severity levels (SEV-1 to SEV-5) add enterprise complexity with no AI benefit
1517+
- Success metrics ("5+ incidents/month") force artificial incident creation
1518+
- Schema breaks all established patterns (no frontmatter linking, no AI guidance, no archive)
1519+
1520+
**What Was Kept:** Lightweight incident entry format added to DEVLOG template with `🚨 INCIDENT` prefix for easy filtering, structured root-cause/prevention fields, and a short rubric of qualifying events. Same learning value, 90% fewer tokens.
1521+
15041522
---
15051523

15061524
## Future Considerations (v2.0+)

0 commit comments

Comments
 (0)