Home

Où trouver les différentes documentations ?

Tout dépend du type de documentation que vous cherchez mais voici une liste vous permettant de vous y retrouver.

Pratiques de travail et base de connaissances

Sur ce wiki

• PratiquesDeDéveloppement
• IntégrationContinue
• TestsUnitaires
• Repository

Installation et/ou configuration du projet

Le/les fichiers README présents dans le projet.

• https://github.com/DITP-pilotage/pilote-2/blob/main/README.md
• https://github.com/DITP-pilotage/pilote-2/blob/main/data/pilote_data_jobs/README.md
• Configuration et mise à jour des variables d'environnement pour les datajobs

Checklist pour mise en production

Voir : ChecklistDeMiseEnProd.

Historique de nos décisions d'architecture (ADR)

Le dossier /doc/adr à la racine du projet.

• https://github.com/DITP-pilotage/pilote-2/blob/main/doc/adr

Documentation métier

Les tests dans l'application. Au besoin un commentaire dans le code peut être présent sur des règles métiers particulières.

Documentation du code

Via l'usage de Typescript et la façon de nommer les variables / fonctions. Au besoin un commentaire peut être présent sur les fonctions qui pourraient porter à confusion.