Update design
Review recent ADRs, experiments, and code changes, then update docs/design.md accordinglyFrom its SKILL.md
npx -y skills add cliffren/swf --skill update-designAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 5 stars5 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.9 KB, as published. Nobody here has run it
Update Design Document
Review recent changes and update docs/design.md to keep it current.
Prerequisite
Every design.md change MUST be backed by an ADR. If no recent ADR exists:
- Ask: "没有找到未同步的 ADR。要先用
/swf:adr记录决策吗?" - Do NOT proceed to modify design.md without an ADR as justification
- No exceptions
Workflow
-
Gather what changed:
- Read all ADRs in
docs/adr/— identify any not yet reflected in design.md - Read current
docs/design.md
- Read all ADRs in
-
Identify deltas:
- List specific sections of design.md that need updating
- For each delta, note the source (which ADR, experiment, or commit)
-
Present changes to user:
## design.md 需要更新的部分 1. **Section: 数据存储层** 原因:ADR-003 决定使用 sparse matrix 变更:将 dense array 描述改为 sparse matrix,更新相关 API 2. **Section: 性能估算** 原因:实验 exp-002 显示内存占用低于预期 变更:更新内存估算数据 确认更新吗? -
Apply changes after user confirms:
- Edit
docs/design.mdwith the identified changes - Preserve the document's overall structure and style
- Add a changelog entry at the bottom if one exists
- Edit
-
Commit:
git add docs/design.md- Commit with message:
docs: update design.md (based on ADR-NNN, exp-NNN)
Rules
- NEVER modify design.md without user confirmation
- NEVER delete existing content without explicit approval — prefer updating or annotating
- If there are no changes needed, say so: "design.md 已是最新,无需更新"
- This is the ONLY approved way to modify design.md (per CLAUDE.md conventions)
- Every change must trace back to an ADR or experiment record — no ad-hoc edits