Skip to content

Latest commit

 

History

History

README.md

title Reference Documentation
id RM-013
type
readme
status
approved
owner Auriora Team
last_reviewed 27-10-2023
tags
readme
reference
links
tooling

Reference Documentation

  • Owner: Auriora Team
  • Status: Approved
  • Created Date: 27-10-2023
  • Last Updated: 27-10-2023

1. Purpose

When to use this template: This folder contains reference materials that provide detailed information on specific topics, such as tooling, APIs, or licensing. These documents are typically stable and serve as authoritative sources of truth. Location: docs/reference/

2. What Belongs Here?

  • Documentation for project-specific tools and utilities.
  • API specifications or data schemas.
  • Licensing information and compliance guidelines.

Available Reference Documents

API References

Guides and Specifications

3. What Does NOT Belong Here?

  • Step-by-step guides (see ../guides/).
  • Architectural decisions (see ../2-architecture/).
  • Chronological updates (see ../updates/).

4. Usage Notes

  • Checklist for Authors:

    • Fill in all placeholder values (e.g., [Name or Team]).
    • Delete this Usage Notes section before publishing.
    • Ensure the document is linked from the relevant README.md file.
  • Naming Convention: N/A for this file.

5. Available Templates

  • _template.md: A generic template for any reference document.

References

  • Link to additional resources, specs, or tickets