85 lines
2.3 KiB
Markdown
85 lines
2.3 KiB
Markdown
# epic.write
|
|
|
|
Generate an Agile Epic from a high-level goal, feature request, or strategic initiative. Creates structured Agile Epic document that follows best practices.
|
|
|
|
## Overview
|
|
|
|
**Purpose:** Generate an Agile Epic from a high-level goal, feature request, or strategic initiative. Creates structured Agile Epic document that follows best practices.
|
|
|
|
**Command:** `/epic/write`
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```bash
|
|
python3 skills/epic/write/epic_write.py
|
|
```
|
|
|
|
### With Arguments
|
|
|
|
```bash
|
|
python3 skills/epic/write/epic_write.py \
|
|
--initiative_name_(string,_required):_the_overarching_initiative_or_product_goal "value" \
|
|
--context_(string,_required):_relevant_background,_rationale,_and_success_criteria "value" \
|
|
--stakeholders_(array_of_strings,_required):_who_cares_about_this_and_why "value" \
|
|
--output_path_(string,_optional):_where_to_save_the_epic.md_file_(default:_./epic.md) "value" \
|
|
--output-format json
|
|
```
|
|
|
|
## Inputs
|
|
|
|
- **initiative_name (string, required): The overarching initiative or product goal**
|
|
- **context (string, required): Relevant background, rationale, and success criteria**
|
|
- **stakeholders (array of strings, required): Who cares about this and why**
|
|
- **output_path (string, optional): Where to save the epic.md file (default: ./epic.md)**
|
|
|
|
## Outputs
|
|
|
|
- **epic.md: Markdown file with structured Epic fields (title, summary, background, acceptance criteria, stakeholders, next steps)**
|
|
|
|
## Artifact Metadata
|
|
|
|
### Produces
|
|
|
|
- `agile-epic`
|
|
|
|
## Examples
|
|
|
|
- python3 skills/epic.write/epic_write.py --initiative-name "Customer Self-Service Portal" --context "Enable customers to manage accounts" --stakeholders "Product Team,Engineering"
|
|
|
|
## Permissions
|
|
|
|
- `filesystem:read`
|
|
- `filesystem:write`
|
|
|
|
## Implementation Notes
|
|
|
|
Validate all required inputs are provided. Generate clear, measurable acceptance criteria. Format output following Agile Epic standards. Include metadata for artifact tracking. Provide clear guidance on next step (epic.decompose).
|
|
|
|
## Integration
|
|
|
|
This skill can be used in agents by including it in `skills_available`:
|
|
|
|
```yaml
|
|
name: my.agent
|
|
skills_available:
|
|
- epic.write
|
|
```
|
|
|
|
## Testing
|
|
|
|
Run tests with:
|
|
|
|
```bash
|
|
pytest skills/epic/write/test_epic_write.py -v
|
|
```
|
|
|
|
## Created By
|
|
|
|
This skill was generated by **meta.skill**, the skill creator meta-agent.
|
|
|
|
---
|
|
|
|
*Part of the Betty Framework*
|