Backend Design Docs - a2n-seattle/rms-app GitHub Wiki

2021 RMS

2025 RMS

  • Sprint 1:
    • Add AI Chatbot to maintain services
    • Add fields to the main table
  • Sprint 2:
    • Create User Table & Services

WWH Template (Replace everything in the <>)

Field Value
Milestone: <Create new Milestone to organize all sub-tasks under>
Owner: <Main Owner for the Project>
Contributors: <Other Contributors to the Project>
Reviewer: <Reviewer of the Project Spec>
Status: <Current Status of the Document. Either: In Progress / In Review / Approved / Rejected>

Why?

As a <the person or role who will benefit from the feature>

I want <the feature>

So that <the benefit or value of the feature>

Put this as documentation on top of the class

<If Necessary, insert further narrative of what the current behavior is, and why it is painful>

What?

<Give a high level description of what the feature is>

How?

Task Breakdown

  • [<Task 1>](<Link to Task 1 Issue>)

    • <Description of what needs to be done for the task>

    • <Also write any other concerns that you might have about the implementation of the task>

Acceptance Criteria

Scenario Expected Response
When <a certain input is given> Will <have expected response>

These scenarios should be written up as tests, using the following naming convention:

'will <have expected response> when <a certain input is given>'

⚠️ **GitHub.com Fallback** ⚠️