mirror of
https://github.com/github/spec-kit.git
synced 2026-01-30 12:42:02 +00:00
1.9 KiB
1.9 KiB
Feature Specification: [FEATURE NAME]
Feature Branch: [###-feature-name]
Created: [DATE]
Status: Draft
Input: User description: "$ARGUMENTS"
User Scenarios & Testing (mandatory)
Primary User Story
[Describe the main user journey in plain language]
Acceptance Scenarios
- Given [initial state], When [action], Then [expected outcome]
- Given [initial state], When [action], Then [expected outcome]
Edge Cases
- What happens when [boundary condition]?
- How does system handle [error scenario]?
Requirements (mandatory)
Functional Requirements
- FR-001: System MUST [specific capability, e.g., "allow users to create accounts"]
- FR-002: System MUST [specific capability, e.g., "validate email addresses"]
- FR-003: Users MUST be able to [key interaction, e.g., "reset their password"]
- FR-004: System MUST [data requirement, e.g., "persist user preferences"]
- FR-005: System MUST [behavior, e.g., "log all security events"]
Example of marking unclear requirements:
- FR-006: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?]
- FR-007: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
Key Entities (include if feature involves data)
- [Entity 1]: [What it represents, key attributes without implementation]
- [Entity 2]: [What it represents, relationships to other entities]