Philosophie

Structure globale

Le menu principal est organisé de façon à trouver le plus rapidement ce que l'on souhaite en fonction du contexte dans lequel on est. Cette division est actuellement faite autour de chaque équipe ou grandes problématiques transverse aux équipes.

Ces sections sont ordonnées de façon à introduire les concepts dans l'ordre que pourrait souhaiter un nouvel arrivant dans l'équipe.

ADR

Les ADRs sont organisés via le système de blog de MkDocs afin de pouvoir bénéficier du système dynamique de regroupement des documents par catégorie.

Ces documents sont également triés par nature par leur date de création ce qui permet d'avoir une vue chronologique de l'évolution de nos pratiques.

Et puisque ces documents peuvent devenir obsolète, la pratique est de les conserver mais de les classer dans une catégorie Déprécié. La logique est de conserver une connaissance même si obsolète pour facilement revenir sur pourquoi on a abandonné certaines pratiques.

Documentation historique

La documentation déjà existante avant la création de ce site est disponible dans le menu Legacy.

Tout comme le code il n'est pas forcément souhaitable de tout migrer d'un seul coup. Ce menu est donc amené à rester le temps de migrer progressivement toutes les docs (le temps que toute l'équipe se familiarise avec ce nouvel outil).