How to Tech

The purposes of the tech documentation are to provide a clear and concise overview of the technology used and how we use them.

Image

Include an image of the technology (logo, icon, etc.).

Wiki

We don’t aim to rewrite the official documentation.
Instead, include:

• A link to the official documentation
• A link to Wikipedia or another reliable source for a quick definition or explanation

Introduction

A short introduction to the technology:

• What it is
• What it`s used for
• Why it`s relevant to the project One to three sentences should be enough.

Usage

What do we use it for? How do we use it? Keep it simple and clear.

• The specific use case are in the doc of the specific project. With the link to this tech.

Security

Highlight key security considerations:

• What protections are in place
• What users/developers should watch out for

Best Practice

A summary of best practices for using the technology effectively and securely.

Test

A brief overview of how to test the technology, including any specific tools or frameworks used.