Skip to content

Documentation

Standards

Technical TNA standards are documented in this handbook whose source code is available on GitHub.

These standards SHOULD apply to all TNA projects.

Requesting changes

Anyone in TNA is able to open an issue or pull request to this handbook.

Suggestions for new technologies or standards can be done with a RFC process.

  1. Open an issue using the proposal template
  2. The TGB will review the proposal and ask questions in the open, taking unresolved queries to the TAG
  3. A pull request can then be opened to change the standards

Project documentation

  1. Location
    1. All services MUST have a landing page in Confluence
    2. Project documentation MUST NOT be added to SharePoint
    3. Project documentation MUST NOT be added to Google Drive
    4. Project documentation SHOULD be open and accessible to the public if possible
  2. Diagrams
    1. Mermaid diagrams SHOULD be used for simple diagrams such as sequence and C4 diagrams
    2. LucidChart SHOULD be used for more complex diagrams
    3. draw.io COULD be used for more complex diagrams if access to LucidChart is limited
  3. Applications
    1. Each application MUST have a README.md that briefly explains the application and how to get started
    2. Each application SHOULD have a MKDocs-compatible docs directory with more detailed developer documentation