Documentation technique de l’application¶
Par ou commencer ?¶
Cette documentation aide les développeurs et toute personne s’intéressant à la construction technique de la plateforme à comprendre son architecture, son fonctionnement et les prises de décision qui y ont abouties.
Elle est répartie en 4 sections suivant la convention DIATAXIS
Pour en savoir plus sur la construction de cette documentation, suivez le guide : Guide de la documentation technique
Référence¶
Contient toute la description technique de l’application, par exemple :
Architecture des fichiers
Architecture des données
Conventions de code et de base de données …
Explications¶
Description de comment ça marche et des prises de décision, par exemple :
Pourquoi ce choix d’architecture des données
Principe sanitaire mise en place sur la platefome données …
Tutoriels¶
Décrit les apprentissages pas à pas de l’utilisation des outils, par exemple
Installation d’un poste développeur
Mise en production …
Comment faire ?¶
Guide l’utilisateur pour résoudre un problème, par exemple :
Copie de la base de données de prod vers preprod
Debugage …