-
Notifications
You must be signed in to change notification settings - Fork 0
Optimize skill descriptions and content for better triggering #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| .DS_Store | ||
| **/.DS_Store | ||
| reference | ||
| skills-workspace |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| name: traceability-checker | ||
| description: "Use when verifying cross-references, checking requirement traceability, finding orphan specs or stories, validating coverage completeness, or building a traceability matrix. Provides forward/backward traceability rules, cross-reference validation, and coverage metrics." | ||
| description: "Trigger whenever the user asks to check, validate, or audit connections between requirements artifacts. This includes: cross-reference checking between screens, specs, and use cases; building traceability matrices; finding orphaned or unlinked specs, stories, or epics; generating coverage reports; or asking questions like 'what's missing', 'what's not covered', 'is everything linked', 'are requirements covered', 'find gaps', 'check my cross-references', or 'what specs don't have stories yet'. Use for any verification of existing spec-to-delivery linkage — not for creating or writing new specs, stories, or use cases. Also use before sprint starts to verify story-to-spec traceability, or after creating new specs to check they're properly linked. Provides forward/backward traceability rules, cross-reference validation, coverage metrics, orphan detection, broken reference scanning, and structured reporting." | ||
| user-invocable: false | ||
| --- | ||
|
|
||
|
|
@@ -68,6 +68,36 @@ Report findings as a structured table: | |
| | BRs referenced by UCs | N / N | NN% | | ||
| ``` | ||
|
|
||
| ## Check Modes | ||
|
|
||
| ### Full Scan (default for `/check-traceability`) | ||
| Scans all specs and delivery artifacts across the entire `docs/` directory. Use when: | ||
| - Starting a new sprint or release | ||
| - After a batch of specs have been created | ||
| - Before presenting traceability to stakeholders | ||
|
|
||
| ### Focused Check (for a specific scope) | ||
| When the user specifies a scope (e.g., a single epic, spec, or directory), only scan the relevant artifacts and their direct references. Use when: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This guidance says focused checks can target a directory, but Useful? React with 👍 / 👎. |
||
| - The user just created a new spec and wants to verify it's linked properly | ||
| - Checking a single epic's stories before sprint planning | ||
| - Validating a Phase 2 delta's cross-references | ||
|
|
||
| For focused checks, still report any broken outbound references (e.g., if the new spec references a UC that doesn't exist), but don't report unrelated orphans. | ||
|
|
||
| ### Quick Validation (after single artifact creation) | ||
| When a single spec or story was just created, do a lightweight check: | ||
| 1. Verify the new artifact's outbound references exist | ||
| 2. Check if any existing specs should reference the new artifact but don't | ||
| 3. Report only issues related to the new artifact | ||
|
|
||
| ## Common Patterns to Flag | ||
|
|
||
| - **Orphan Business Rules**: BR specs not referenced by any UC — often indicates the rule was defined but never wired into a use case | ||
| - **Stories without ACs**: User stories missing Given/When/Then — blocks sprint readiness | ||
| - **One-way references**: UC references a Screen, but Screen doesn't reference back to the UC | ||
| - **Phantom codes**: A spec references `UC0005` but no file with that code exists | ||
| - **TBD overload**: Specs with more than 3 unresolved TBDs — flag for completion before decomposition | ||
|
|
||
| ## Reference | ||
|
|
||
| - Traceability content: SRS Overview §8 (Traceability & Coverage) in `templates/software_spec/srs_overview.template.md` | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step makes
/phase-deltaan alternative implementation path after CR approval, but the documented workflow requires/apply-changeat implementation time (change_management_rules.md§1/§2). If users follow this guidance and run only/phase-delta, they create a delta file without applying the rest of the approved change set (story/sprint updates and end-to-end verification), which can leave a CR partially implemented while appearing complete.Useful? React with 👍 / 👎.