jpmschweitzerandClaude Opus 4.6
a2edd9025e
Break the MASTERPLAN into 8 milestone documents (M1-M8) with a standard template. Each milestone includes prerequisites, current state assessment, numbered implementation tasks with file references, testing checkpoints, acceptance criteria, and risk analysis. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
84 lines
2.5 KiB
Markdown
84 lines
2.5 KiB
Markdown
# Template for Milestone Documents
|
|
|
|
This template defines the standard structure for all milestone docs. Every
|
|
milestone document MUST follow this format exactly to ensure consistency.
|
|
|
|
---
|
|
|
|
## Document Structure
|
|
|
|
```markdown
|
|
# M[N]: [Title]
|
|
|
|
> [One-line vision statement in italics — what this milestone achieves]
|
|
|
|
## Prerequisites
|
|
|
|
- List of milestones or conditions that must be complete before starting
|
|
- Reference specific outputs from prior milestones that this one depends on
|
|
|
|
## Current State
|
|
|
|
Brief assessment of what already exists in the codebase relevant to this
|
|
milestone. Reference specific files and their current implementation status.
|
|
Use the format `path/to/file.txt` (relative to `mistborn_final_empire/`).
|
|
|
|
## Implementation Tasks
|
|
|
|
Numbered task groups, each with subtasks. Each task should be specific enough
|
|
for an agent to implement without ambiguity.
|
|
|
|
### [N].1 — [Task Group Name]
|
|
|
|
**Context:** Why this task group exists and what it achieves.
|
|
|
|
**Steps:**
|
|
1. Specific action (file to create/modify, what to add/change)
|
|
2. Another specific action
|
|
3. ...
|
|
|
|
**Files:**
|
|
- `path/to/file.txt` — create | modify | rewrite
|
|
- ...
|
|
|
|
**References:**
|
|
- Existing code patterns to follow: `path/to/example.txt:line_range`
|
|
- Vanilla CK3 reference files to consult
|
|
- Lore references in `docs/lore/`
|
|
|
|
---
|
|
|
|
(Repeat for each task group)
|
|
|
|
## Testing Checkpoints
|
|
|
|
Ordered list of verification points. Each checkpoint states:
|
|
- **When:** After which task group(s)
|
|
- **Test:** What to verify (boot test, event fires, trait appears, etc.)
|
|
- **Expected result:** What success looks like
|
|
|
|
## Acceptance Criteria
|
|
|
|
Bulleted list of concrete, testable statements that define "this milestone is
|
|
complete." Every criterion must be verifiable by launching the mod and
|
|
performing specific actions or inspecting specific outputs.
|
|
|
|
## Risks & Mitigations
|
|
|
|
Known technical risks specific to this milestone and how to handle them.
|
|
|
|
## Open Questions
|
|
|
|
Decisions that must be made during implementation. Flag these for the team lead.
|
|
```
|
|
|
|
## Writing Guidelines
|
|
|
|
- Be specific: "Add trait_kandra to common/traits/" not "implement kandra"
|
|
- Reference existing patterns: "Follow the pattern in 00_allomancy_traits.txt"
|
|
- Include CK3 syntax details where non-obvious (scope, trigger syntax, etc.)
|
|
- Keep task groups to 3-7 steps each — break larger groups into sub-groups
|
|
- Every file mentioned should include create/modify/rewrite intent
|
|
- Every localization key pattern should specify the file it belongs in
|
|
- Reference the MASTERPLAN.md scope section for this milestone as the authority
|