Skip to content

Commit 61647bd

Browse files
Update Ralph skill to include final documentation story requirement
Co-authored-by: Miyamura80 <38335479+Miyamura80@users.noreply.github.com>
1 parent 7579baa commit 61647bd

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

.claude/skills/ralph/SKILL.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,26 @@ Frontend stories are NOT complete until visually verified. Ralph will use the de
110110
4. **All stories**: `passes: false` and empty `notes`
111111
5. **branchName**: Derive from feature name, kebab-case, prefixed with `ralph/`
112112
6. **Always add**: "Typecheck passes" to every story's acceptance criteria
113+
7. **Final Story**: Always include a final story for documentation (README, Makefile) and verification.
114+
115+
## The Final Documentation Story
116+
117+
**Every** prd.json must end with a story dedicated to documentation and cleanup.
118+
119+
**Requirements for the final story:**
120+
- Update `README.md` (if necessary) to document new features
121+
- Update `Makefile` (if necessary) with new commands
122+
- Document how to execute and test the new code
123+
- Verify all tests and typechecks pass
124+
125+
**Example acceptance criteria:**
126+
```
127+
"Update README.md with instructions for [feature]",
128+
"Update Makefile if new build/test steps are needed",
129+
"Document how to run and test the changes",
130+
"Typecheck passes",
131+
"All tests pass"
132+
```
113133

114134
## Splitting Large PRDs
115135

@@ -205,6 +225,21 @@ Add ability to mark tasks with different statuses.
205225
"priority": 4,
206226
"passes": false,
207227
"notes": ""
228+
},
229+
{
230+
"id": "US-005",
231+
"title": "Documentation and Cleanup",
232+
"description": "Ensure code is well-documented and buildable.",
233+
"acceptanceCriteria": [
234+
"Update README.md with status feature instructions",
235+
"Update Makefile if necessary",
236+
"Document how to test status filtering",
237+
"Typecheck passes",
238+
"All tests pass"
239+
],
240+
"priority": 5,
241+
"passes": false,
242+
"notes": ""
208243
}
209244
]
210245
}
@@ -234,3 +269,4 @@ Before writing prd.json, verify:
234269
- [ ] UI stories have "Verify in browser using dev-browser skill" as criterion
235270
- [ ] Acceptance criteria are verifiable (not vague)
236271
- [ ] No story depends on a later story
272+
- [ ] Final story covers README, Makefile, and documentation

0 commit comments

Comments
 (0)