UserStory
A UserStory captures a high-level requirement from the perspective of a role. It maps to the classic As a / I want / so that format via the who, what, and why fields.
Stories are classified as functional or technical using UserStoryType.
UserStoryType
UserStoryType
Bases: str, Enum
Classifies a UserStory as functional or technical.
UserStory
UserStory
Bases: MergeableModel
A high-level requirement scoped to an organizational unit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
Integer identifier, unique within the enclosing Scope. |
required | |
who
|
The role or persona that wants the feature. |
required | |
what
|
The capability or behaviour desired. |
required | |
why
|
The business or technical justification. |
required | |
type
|
Whether the story is functional or technical. |
required | |
active
|
Whether this story is an active requirement.
Set to |
required | |
acceptance_criteria
|
The testable conditions defining completion. Each criterion's id must be unique within this story. |
required |
is_validated
property
Return True when the story is active, has active criteria, and all are validated.