«Que faire de mes objets et déchets» Technical documentation¶
Summary¶
Where to start?¶
This documentation helps developers and anyone interested in the technical construction of the platform to understand its architecture, how it works, and the decisions that led to it.
It is divided into 4 sections (partly inspired by the DIATAXIS convention)
Getting started¶
Explain how install and use the application locally
-> This section should be implemented
Reference¶
Contains the full technical description of the application, for example:
File architecture
Data architecture
Code and database conventions …
Explanations¶
Describes how things work and the decisions made, for example:
Why this choice of data architecture
Safety principles implemented on the data platform …
How-to guides¶
Helps the user solve a problem, for example:
Copying the production database to preproduction
Debugging …