phase6-summarize.md

 1# Phase 6: Summarize Changes
 2
 3You are generating a summary of documentation updates for PR review.
 4
 5## Objective
 6Create a clear, reviewable summary of all documentation changes made.
 7
 8## Input
 9You will receive:
10- Applied changes report from Phase 5
11- Original change analysis from Phase 3
12- Git diff of documentation changes
13
14## Instructions
15
161. **Gather Change Information**
17   - List all modified documentation files
18   - Identify the corresponding code changes that triggered each update
19
202. **Generate Summary**
21   Use the format specified in `docs/AGENTS.md` Phase 6 section:
22
23```markdown
24## Documentation Update Summary
25
26### Changes Made
27| File | Change | Related Code |
28| --- | --- | --- |
29| docs/src/path.md | Brief description | PR #123 or commit SHA |
30
31### Rationale
32Brief explanation of why these updates were made, linking back to the triggering code changes.
33
34### Review Notes
35- Items reviewers should pay special attention to
36- Any uncertainty flags from Phase 4 that were addressed
37- Assumptions made during documentation
38```
39
403. **Add Context for Reviewers**
41   - Highlight any changes that might be controversial
42   - Note if any planned changes were skipped and why
43   - Flag areas where reviewer expertise is especially needed
44
45## Output Format
46The summary should be suitable for:
47- PR description body
48- Commit message (condensed version)
49- Team communication
50
51## Constraints
52- Read-only (documentation changes already applied in Phase 5)
53- Factual: Describe what was done, not justify why it's good
54- Complete: Account for all changes, including skipped items