write-user-story
4
总安装量
4
周安装量
#50042
全站排名
安装命令
npx skills add https://github.com/folio-org/folio-eureka-ai-dev --skill write-user-story
Agent 安装分布
opencode
4
gemini-cli
4
github-copilot
4
codex
4
kimi-cli
4
cursor
4
Skill 文档
Write User Story
User Story Structure
Every story must have these sections (in order):
- Purpose/Overview â What it achieves and why. Include business context, user persona, and links. Optionally add a Technical Details/Approach sub-section for architectural decisions without over-specifying implementation.
- Requirements/Scope â Functional requirements (specific, measurable). Non-functional requirements only when they have measurable impact. Out of Scope only when genuine ambiguity exists.
- Acceptance Criteria â Testable conditions in Given-When-Then format.
- Testing Guidance â Manual testing scenarios only. No unit/integration test specs.
Template
## Purpose/Overview
[High-level description of what this story achieves and why it's important.
Include business context, user persona, and links to related work.]
### Technical Details/Technical Approach (Optional)
[Architectural decisions or implementation strategy â don't over-specify.]
---
## Requirements/Scope
### Functional Requirements
1. [Specific functionality to implement]
2. [Input/output expectations]
3. [Business rules and constraints]
### Non-Functional Requirements (only if significant)
1. [Data integrity requirements]
2. [Performance â only if measurable impact]
3. [Security â only if specific requirements exist]
### Out of Scope (only if needed for clarity)
- [Include ONLY if there's genuine ambiguity about scope]
---
## Acceptance Criteria
**AC1: [Scenario name]**
- Given [initial context]
When [action occurs]
Then [expected outcome]
**AC2: [Error handling scenario]**
- Given [error condition]
When [action occurs]
Then [expected error behavior]
---
## Testing Guidance
### Manual Testing
**Scenario 1: [Primary user workflow]**
1. [Step-by-step instructions]
2. [Expected outcomes]
**Scenario 2: [Edge case]**
1. [Steps]
2. [Expected outcomes]
**Note:** Unit test specs, integration test code, and test data details belong in the implementation plan, not here.
---
## Additional Notes (optional)
[Risks, dependencies, or other considerations]
## Related Links (optional)
- [Design documents, API specs, related stories]
Writing Guidelines
Standard User Story Format
As a [user persona/role]
I want [goal/desire]
So that [benefit/value]
INVEST Principles
- Independent â deliverable separately
- Negotiable â details can be refined
- Valuable â delivers clear value
- Estimable â team can estimate effort
- Small â completable within one sprint
- Testable â clear verification criteria
Best Practices
Do’s â
- Write from the user perspective â focus on value, not implementation
- Make acceptance criteria specific and testable
- Include error scenarios and edge cases
- Use consistent domain terminology
- Link dependencies and related stories
- Collaborate with developers, testers, and stakeholders
Don’ts â
- Don’t write technical tasks as stories (“Refactor UserService” is a task, not a story)
- Don’t be vague â “improve performance” needs metrics
- Don’t skip acceptance criteria
- Don’t add non-functional requirements unless they have measurable impact
- Don’t add “Out of Scope” unless there’s genuine ambiguity
- Don’t include unit/integration test specs in Testing Guidance
- Don’t over-specify implementation â leave the “how” to developers
Quick Reference Checklist
- Purpose clearly explains the value and context
- Requirements are specific and measurable
- Acceptance criteria are testable and unambiguous
- Error scenarios and edge cases are covered
- Testing guidance contains manual scenarios only
- Dependencies are identified and linked
- Story is sized for one sprint
- Technical approach is outlined if needed, but not over-specified
- Non-functional requirements included only if significant
- “Out of Scope” omitted unless genuinely needed
For deep-dive guidance on each section, see references/section-details.md. For common pitfalls with before/after examples, see references/pitfalls.md. For a complete example story, see references/example.md. For JIRA markup conversion, see references/jira.md.