/ticket-ok

Primary LanguagePython

Ticket OK

Documentation

Document files can be found in the docs directory. It currently houses the following types of documentations:

  1. Architecture Decision Records (ADRs)
    • "An architecture decision record (ADR) is a document that captures an important architecture decision made along with its context and consequences." source
    • Can be found in docs/adr
  2. Requirements Document
    • A written specification for the application's requirements.
    • Can be found in docs/requirements

For any new document, please add the following metadata at the top:

- Author: John Alcher Doloiras <johnalcherdoloiras@gmail.com>
- Changelog:
    - 01/17/2023 - Status changed to accepted
    - 01/16/2023 - ADR created