Milestone Reporting Skill
Overview
This skill defines the protocol for documenting project milestones. It ensures that technical decisions, experimental results, and architectural changes are preserved beyond the short-term memory of a single session.
When to Use
- BEFORE /compact: You MUST run this skill manually before compacting context.
- Milestone Reached: Use when you have finished a meaningful piece of work (feature, fix, refactor).
Workflow
Phase 1: Context Saturation (Mandatory)
Before generating any files, you MUST perform a deep audit of the work done.
- Identify Scope:
- Review
git logto identify all commits since the last milestone. - If no commits exist, include staged changes (
git diff --staged).
- Review
- Recursive Audit (Anti-Hallucination):
- Trace: For every modified file, identify its upstream callers and downstream dependencies.
- Read: Use
Readto verify the source definitions of changed functions. - Verify: Confirm you understand the exact technical logic, not just the intent.
- Constraint: Do NOT proceed until you can explain the "Ripple Effects" and "Systemic Impact" for every change.
Phase 2: Documentation Generation
- Generate Draft: Use
python skills/milestone/generate_draft.pyto create a draft file and update the timeline. - Fill Content: Immediately read the generated draft and populate it using the
Writetool.- Data Source: Use the knowledge gathered in Phase 1.
- Language Mandate: All content MUST be in Simplified Chinese (简体中文).
- Validation: Verify the file is saved and the content matches the schema.
Phase 3: Finalization (Summary Sync)
After the report is written and verified, you MUST synchronize the summary back to the timeline index.
- Sync: Run
python skills/milestone/sync_timeline.py. - Verify: Check that
.claude/history/timeline.mdnow contains the meaningful Chinese summary from your report.
Content Standards (Strict)
You MUST adhere to the following 4 rules when writing the report:
- Completeness (No Token Saving): DO NOT summarize, compress, or omit technical details to save space/tokens. You MUST preserve the FULL technical context, reasoning, and trade-offs.
- Negative Knowledge (Falsification): You MUST document refuted hypotheses and failed attempts. Explaining "why approach X failed" is as critical as "how approach Y succeeded".
- Style (Objective): Use formal, simple indicative sentences (
Subject+Verb+Object). STRICTLY PROHIBIT unnecessaryAdjectives,Adverbs, andMetaphors(e.g., "elegant solution", "quick fix"). - Epistemic Humility: DO NOT declare "Fixed" or "Solved" without empirical data (logs/tests). Use "Implemented" or "Attempted" for unverified changes. Do not predict future success.
Core Pattern: The Milestone Report
A milestone consists of two parts:
- Index (Timeline): A high-level reverse-chronological list in
.claude/history/timeline.md. - Report: A detailed markdown file in
.claude/history/reports/YYYYMMDD_HHMMSS.md.
Report Schema (Strict Compliance)
You must follow the schema defined in skills/milestone/report_schema.json.
The generator script handles the skeleton; your job is to populate the content in Chinese.
Discovery
The history is indexed in .claude/history/timeline.md. Claude will refer to this index in CLAUDE.md to progressively discover past reports when needed.
