Initial commit
This commit is contained in:
128
skills/spec-scaffold/templates/specification.md
Normal file
128
skills/spec-scaffold/templates/specification.md
Normal file
@@ -0,0 +1,128 @@
|
||||
[FEATURE NAME]
|
||||
===
|
||||
|
||||
**Created On:** [CREATION_DATE]
|
||||
**Last Updated:** [LAST_UPDATED_DATE]
|
||||
**Brief Description:** [BRIEF_DESCRIPTION]
|
||||
|
||||
## Purpose
|
||||
|
||||
<!--
|
||||
Explain why this feature is needed and what problem it solves. And what value it delivers to users.
|
||||
-->
|
||||
|
||||
[PURPOSE_DESCRIPTION]
|
||||
|
||||
## User Stories and Acceptance Criteria **(mandatory)**
|
||||
|
||||
<!--
|
||||
IMPORTANT: User stories should be PRIORITIZED as user journeys ordered by importance.
|
||||
Each story should be INDEPENDENTLY TESTABLE - meaning implementing ONE story at a time,
|
||||
you should focus on delivering viable MVP (Minimum Viable Product) to produce value early and often.
|
||||
|
||||
Assign priorities (P1, P2, P3, etc.) to each story, where P1 is the most critical.
|
||||
Think of each story as a standalone slice of functionality that can be:
|
||||
- Developed independently
|
||||
- Tested independently
|
||||
- Deployed independently
|
||||
- Demonstrated to users independently
|
||||
-->
|
||||
|
||||
<!--
|
||||
User Story Template
|
||||
===
|
||||
|
||||
### User Story X - [BRIEF_TITLE] (Priority: PX)
|
||||
**Priority Explanation:** [Explain why this priority was assigned]
|
||||
**Value Deliveried:** [Describe how this story delivers value independently with testable outcomes]
|
||||
|
||||
```gherkin
|
||||
A brief description of the user story.
|
||||
|
||||
Scenario: [Title of the scenario]
|
||||
When [event occurs]
|
||||
Then [ensure some outcomes]
|
||||
|
||||
Rule: [If any specific business rules apply which group multiple scenarios]
|
||||
|
||||
Scenario: [Title of another scenario]
|
||||
Given [initial context]
|
||||
When [event occurs]
|
||||
Then [ensure some outcomes]
|
||||
```
|
||||
|
||||
- Use `Background:` to define any common preconditions if needed.
|
||||
- Use `Rule:` to define any specific business rules if needed.
|
||||
- Use `Examples:` to provide data tables for scenarios if needed.
|
||||
--->
|
||||
|
||||
### User Story 1 - [BRIEF_TITLE] (Priority: P1)
|
||||
|
||||
**Priority Explanation:** [Explain why this priority was assigned]
|
||||
**Value Deliveried:** [Describe how this story delivers value independently with testable outcomes]
|
||||
|
||||
<!--
|
||||
Use Gherkin style to define acceptance criteria for the user story.
|
||||
-->
|
||||
|
||||
```gherkin
|
||||
A brief description of the user story.
|
||||
|
||||
Background:
|
||||
Given [initial context]
|
||||
And [more initial context]
|
||||
|
||||
Scenario: [Title of the scenario]
|
||||
When [event occurs]
|
||||
Then [ensure some outcomes]
|
||||
|
||||
Scenario: [Title of another scenario]
|
||||
Given [initial context]
|
||||
When [event occurs]
|
||||
Then [ensure some outcomes]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### User Story 2 - [BRIEF_TITLE] (Priority: P2)
|
||||
|
||||
**Priority Explanation:** [Explain why this priority was assigned]
|
||||
**Value Deliveried:** [Describe how this story delivers value independently with testable outcomes]
|
||||
|
||||
```gherkin
|
||||
A brief description of the user story.
|
||||
|
||||
Scenario: [Title of the scenario]
|
||||
When [event occurs]
|
||||
Then [ensure some outcomes]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### User Story 3 - [BRIEF_TITLE] (Priority: P3)
|
||||
|
||||
**Priority Explanation:** [Explain why this priority was assigned]
|
||||
**Value Deliveried:** [Describe how this story delivers value independently with testable outcomes]
|
||||
|
||||
```gherkin
|
||||
A brief description of the user story.
|
||||
|
||||
Scenario: [Title of the scenario]
|
||||
Given [initial context]
|
||||
When [event occurs]
|
||||
Then [ensure some outcomes]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Add more user stories as needed, following the same format]
|
||||
|
||||
## Unclarified Items
|
||||
|
||||
<!--
|
||||
IMPORTANT: This section only include items which user allowed to be left unclear after asking for clarifications.
|
||||
The edge cases not covered by existing information should be explicitly listed here for future resolution.
|
||||
-->
|
||||
|
||||
- [NAME_OF_ITEM]: explanation of what is unclear and why.
|
||||
- [NAME_OF_ITEM]: explanation of what is unclear and why.
|
||||
Reference in New Issue
Block a user