Skip to content

Commit

Permalink
Merge pull request #17 from 51ngul4r1ty/story/000489/document-statuses
Browse files Browse the repository at this point in the history
Added Docs for Backlog Item Status Use
  • Loading branch information
51ngul4r1ty authored Jan 30, 2024
2 parents 35b9e35 + 473e35c commit 960045f
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 3 deletions.
41 changes: 41 additions & 0 deletions docs/User-Guide-Backlog-Item-Statuses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Overview
========

* Todo (aka "Not Started")
* Busy (aka "In Progress")
* Done (aka "Completed")
* Accepted
* Released

Not Started
===========

Backlog items that aren't being worked. Note that there are sub-states that
apply to these items- they may still need to be fully defined. In future a
"Ready" status may be introduced.

In Progress
===========

Items that are actively being worked. Items could still be paused to work on
other items, but once they're started they will be in this state.

Completed
=========

The work on this item has been done- this includes QA testing.

Accepted
========

This item has been accepted by stakeholder representatives (typically Product
Owners or someone acting that role).

Released
========

Typically story work is released to a production environment, but there are
items that are for developers themselves, so "Released" can also mean that the
changes are simply merged into the codebase without actually being deployed.
Whenever a work item is available to the targeted role it should be marked
as released.
10 changes: 9 additions & 1 deletion docs/User-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,13 @@ Overview
This document is the launch point to access information important to all users
of Atoll whatever role they're in: end-user to admin.

End User
========

[Backlog Item Statuses](/User-Guide-Backlog-Item-Statuses.md)

Administrators / Ops
====================

[Configuring Atoll](./User-Guide-Configuring.md)
[Deploying Atoll](./User-Guide-Deployment.md)
[Deploying Atoll](./User-Guide-Deployment.md)
3 changes: 1 addition & 2 deletions packages/web-app/src/server/api/handlers/backlogItems.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ import {
formatNumber,
getValidStatuses,
isValidStatus,
logger,
mapApiItemToBacklogItem
logger
} from "@atoll/shared";

// data access
Expand Down

0 comments on commit 960045f

Please sign in to comment.