Skip to content

Commit 5333409

Browse files
committed
Cleanup redundancies
1 parent 08b2a0a commit 5333409

1 file changed

Lines changed: 50 additions & 50 deletions

File tree

templates/commands/checklist.md

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -60,64 +60,66 @@ You **MUST** consider the user input before proceeding (if not empty).
6060
- spec.md: Feature requirements and scope
6161
- plan.md (if exists): Technical details, dependencies
6262
- tasks.md (if exists): Implementation tasks
63-
- Use context to enrich or validate checklist items (omit irrelevant categories)
63+
64+
**Context Loading Strategy**:
65+
- Load only necessary portions relevant to active focus areas (avoid full-file dumping)
66+
- Prefer summarizing long sections into concise scenario/requirement bullets
67+
- Use progressive disclosure: add follow-on retrieval only if gaps detected
68+
- If source docs are large, generate interim summary items instead of embedding raw text
6469

6570
5. **Generate checklist**:
6671
- Create `FEATURE_DIR/checklists/` directory if it doesn't exist
6772
- Generate unique checklist filename:
68-
* Use short, descriptive name based on checklist type
69-
* Format: `[type].md` (e.g., `ux.md`, `test.md`, `security.md`, `deploy.md`)
70-
* If file exists, append to existing file (e.g., use the same UX checklist)
73+
- Use short, descriptive name based on checklist type
74+
- Format: `[type].md` (e.g., `ux.md`, `test.md`, `security.md`, `deploy.md`)
75+
- If file exists, append to existing file (e.g., use the same UX checklist)
7176
- Number items sequentially starting from CHK001
72-
- Group items by category/section ONLY using this controlled set:
73-
- Primary Flows
74-
- Alternate Flows
75-
- Exception / Error Flows
76-
- Recovery & Resilience
77-
- Non-Functional Domains (sub‑grouped or prefixed: Performance, Reliability, Security & Privacy, Accessibility, Observability, Scalability, Data Lifecycle)
78-
- Traceability & Coverage
79-
- Ambiguities & Conflicts
80-
- Assumptions & Dependencies
81-
- Do NOT invent ad-hoc categories; merge sparse categories (<2 items) into the closest higher-signal category.
82-
- Add traceability refs when possible (order: spec section, acceptance criterion). If no ID system exists, create an item: `Establish requirement & acceptance criteria ID scheme before proceeding`.
83-
- Optional brief rationale ONLY if it clarifies requirement intent or risk; never include implementation strategy, code pointers, or test plan details.
8477
- Each `/checklist` run creates a NEW file (never overwrites existing checklists)
85-
- **CRITICAL**: Focus on requirements & scenario coverage quality (NOT implementation). Enforce clarity, completeness, measurability, domain & cross-cutting obligations; surface ambiguities / assumptions / conflicts / dependencies. NEVER include implementation details (tests, code symbols, algorithms, deployment steps).
86-
- Soft cap: If raw candidate items > 40, prioritize by risk/impact, consolidate minor edge cases, and add one consolidation item: `Consolidate remaining low-impact scenarios (see source docs) after priority review`.
87-
- Minimum traceability coverage: ≥80% of items MUST include at least one traceability reference (spec section OR acceptance criterion). If impossible (missing structure), add corrective item: `Establish requirement & acceptance criteria ID scheme before proceeding` then proceed.
88-
89-
**Scenario Modeling & Traceability (MANDATORY)**:
90-
- Classify scenarios into: Primary, Alternate, Exception/Error, Recovery/Resilience, Non-Functional (performance, reliability, security/privacy, accessibility, observability, scalability, data lifecycle) where applicable.
91-
- At least one item per present scenario class; if a class is intentionally absent add: `Confirm intentional absence of <Scenario Class> scenarios`.
92-
- Each item MUST include ≥1 of: scenario class tag, spec ref `[Spec §X.Y]`, acceptance criterion `[AC-##]`, or marker `(Assumption)/(Dependency)/(Ambiguity)/(Conflict)` (track coverage ratio for ≥80% traceability rule).
93-
- Surface & cluster (
78+
79+
**Category Structure** - Group items ONLY using this controlled set:
80+
- Primary Flows
81+
- Alternate Flows
82+
- Exception / Error Flows
83+
- Recovery & Resilience
84+
- Non-Functional Domains (sub‑grouped or prefixed: Performance, Reliability, Security & Privacy, Accessibility, Observability, Scalability, Data Lifecycle)
85+
- Traceability & Coverage
86+
- Ambiguities & Conflicts
87+
- Assumptions & Dependencies
88+
89+
Do NOT invent ad-hoc categories; merge sparse categories (<2 items) into the closest higher-signal category.
90+
91+
**Scenario Classification & Coverage**:
92+
- Classify scenarios into: Primary, Alternate, Exception/Error, Recovery/Resilience, Non-Functional
93+
- At least one item per present scenario class; if intentionally absent add: `Confirm intentional absence of <Scenario Class> scenarios`
94+
- Include resilience/rollback coverage when state mutation or migrations occur (partial write, degraded mode, backward compatibility, rollback preconditions)
95+
- If a major scenario lacks acceptance criteria, add an item to define measurable criteria
96+
97+
**Traceability Requirements**:
98+
- MINIMUM: ≥80% of items MUST include at least one traceability reference
99+
- Each item should include ≥1 of: scenario class tag, spec ref `[Spec §X.Y]`, acceptance criterion `[AC-##]`, or marker `(Assumption)/(Dependency)/(Ambiguity)/(Conflict)`
100+
- If no ID system exists, create an item: `Establish requirement & acceptance criteria ID scheme before proceeding`
101+
102+
**Surface & Resolve Issues**:
103+
- Cluster and create one resolution item per cluster for:
94104
- Ambiguities (vague terms: "fast", "robust", "secure")
95105
- Conflicts (contradictory statements)
96106
- Assumptions (unvalidated premises)
97107
- Dependencies (external systems, feature flags, migrations, upstream APIs)
98-
) — create one resolution item per cluster.
99-
- Include resilience/rollback coverage when state mutation or migrations occur (partial write, degraded mode, backward compatibility, rollback preconditions).
100-
- BANNED: references to specific tests ("unit test", "integration test"), code symbols, frameworks, algorithmic prescriptions, deployment steps. Rephrase any such user input into requirement clarity or coverage validation.
101-
- If a major scenario lacks acceptance criteria, add an item to define measurable criteria.
102-
103-
**Context Curation (High-Signal Tokens Only)**:
104-
- Load only necessary portions of `spec.md`, `plan.md`, `tasks.md` relevant to active focus areas (avoid full-file dumping where sections are irrelevant).
105-
- Prefer summarizing long sections into concise scenario/requirement bullets before generating items (compaction principle).
106-
- If source docs are large, generate interim summary items (e.g., `Confirm summary of §4 data retention rules is complete`) instead of embedding raw text.
107-
- Use progressive disclosure: add follow-on retrieval only if a gap is detected (missing scenario class, unclear constraint).
108-
- Treat context budget as finite: do not restate already-tagged requirements verbatim across multiple items.
109-
- Merge near-duplicates when: same scenario class + same spec section + overlapping acceptance intent. Keep higher-risk phrasing; add note if consolidation occurred.
110-
- Do not repeat identical spec or acceptance refs in >3 items unless covering distinct scenario classes.
111-
- If >5 low-impact edge cases (minor parameter permutations), cluster into a single aggregated item.
112-
- If user arguments are sparse, prioritize clarifying questions over speculative item generation.
113-
114-
6. **Structure Reference**: Generate the checklist exactly following the canonical template in `templates/checklist-template.md`. Treat that file as the single source of truth for:
115-
- Title + meta section placement
116-
- Category headings
117-
- Checklist line formatting and ID sequencing
118-
- Prohibited content (implementation details)
119-
120-
If (and only if) the canonical file is missing/unreadable, fall back to: H1 title, purpose/created meta lines, then one or more `##` category sections containing `- [ ] CHK### <imperative requirement-quality item>` lines with globally incrementing IDs starting at CHK001. No trailing explanatory footer.
108+
109+
**Content Consolidation**:
110+
- Soft cap: If raw candidate items > 40, prioritize by risk/impact and add: `Consolidate remaining low-impact scenarios (see source docs) after priority review`
111+
- Merge near-duplicates when: same scenario class + same spec section + overlapping acceptance intent
112+
- If >5 low-impact edge cases, cluster into a single aggregated item
113+
- Do not repeat identical spec or acceptance refs in >3 items unless covering distinct scenario classes
114+
- Treat context budget as finite: do not restate already-tagged requirements verbatim across multiple items
115+
116+
**🚫 PROHIBITED CONTENT** (Requirements Focus ONLY):
117+
- Focus on requirements & scenario coverage quality, NOT implementation
118+
- NEVER include: specific tests ("unit test", "integration test"), code symbols, frameworks, algorithmic prescriptions, deployment steps, test plan details, implementation strategy
119+
- Rephrase any such user input into requirement clarity or coverage validation
120+
- Optional brief rationale ONLY if it clarifies requirement intent or risk
121+
122+
6. **Structure Reference**: Generate the checklist following the canonical template in `templates/checklist-template.md` for title, meta section, category headings, and ID formatting. If template is unavailable, use: H1 title, purpose/created meta lines, `##` category sections containing `- [ ] CHK### <requirement item>` lines with globally incrementing IDs starting at CHK001.
121123

122124
7. **Report**: Output full path to created checklist, item count, and remind user that each run creates a new file. Summarize:
123125
- Focus areas selected
@@ -169,5 +171,3 @@ To avoid clutter, use descriptive types and clean up obsolete checklists when do
169171
- Error handling scenarios
170172
- Backward compatibility considerations
171173
- Integration touchpoint coverage
172-
173-
Principle reminder: Checklist items validate requirements/scenario coverage quality—not implementation. If in doubt, transform any implementation phrasing into a requirement clarity or coverage validation item.

0 commit comments

Comments
 (0)