88 lines
2.3 KiB
Markdown
88 lines
2.3 KiB
Markdown
# story.write
|
|
|
|
Convert decomposed items from epic.decompose into fully formatted user stories. Generates individual Markdown files for each story following standard user story format.
|
|
|
|
## Overview
|
|
|
|
**Purpose:** Convert decomposed items from epic.decompose into fully formatted user stories. Generates individual Markdown files for each story following standard user story format.
|
|
|
|
**Command:** `/story/write`
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```bash
|
|
python3 skills/story/write/story_write.py
|
|
```
|
|
|
|
### With Arguments
|
|
|
|
```bash
|
|
python3 skills/story/write/story_write.py \
|
|
--stories_file_(string,_required):_path_to_the_stories.json_file_from_epic.decompose "value" \
|
|
--epic_reference_(string,_optional):_reference_to_the_source_epic_for_traceability "value" \
|
|
--output_dir_(string,_optional):_directory_to_save_story_files_(default:_./stories/) "value" \
|
|
--output-format json
|
|
```
|
|
|
|
## Inputs
|
|
|
|
- **stories_file (string, required): Path to the stories.json file from epic.decompose**
|
|
- **epic_reference (string, optional): Reference to the source Epic for traceability**
|
|
- **output_dir (string, optional): Directory to save story files (default: ./stories/)**
|
|
|
|
## Outputs
|
|
|
|
- **story_<n>.md: Markdown file per story with persona, goal, benefit, acceptance criteria, and metadata**
|
|
- **stories_index.md: Summary index of all created stories**
|
|
|
|
## Artifact Metadata
|
|
|
|
### Consumes
|
|
|
|
- `user-stories-list`
|
|
|
|
### Produces
|
|
|
|
- `user-story`
|
|
|
|
## Examples
|
|
|
|
- python3 skills/story.write/story_write.py --stories-file ./stories.json --epic-reference "EPIC-001" --output-dir ./stories/
|
|
|
|
## Permissions
|
|
|
|
- `filesystem:read`
|
|
- `filesystem:write`
|
|
|
|
## Implementation Notes
|
|
|
|
Load and parse stories.json. Generate unique story ID for each item. Format as standard user story (As a/I want/So that). Convert acceptance criteria to checklist format. Add traceability links to Epic. Include metadata for tracking. Create summary index file listing all stories. Support batch processing. Validate each story against INVEST criteria.
|
|
|
|
## Integration
|
|
|
|
This skill can be used in agents by including it in `skills_available`:
|
|
|
|
```yaml
|
|
name: my.agent
|
|
skills_available:
|
|
- story.write
|
|
```
|
|
|
|
## Testing
|
|
|
|
Run tests with:
|
|
|
|
```bash
|
|
pytest skills/story/write/test_story_write.py -v
|
|
```
|
|
|
|
## Created By
|
|
|
|
This skill was generated by **meta.skill**, the skill creator meta-agent.
|
|
|
|
---
|
|
|
|
*Part of the Betty Framework*
|