Aller au contenu principal

La macro-technique

Il est déconseillé de documenter votre projet technique en dehors de votre repository Git. Le simple fait de mettre une distance entre votre code et sa propre documentation fait qu'avec le temps ils seront désynchronisés. Utilisez plutôt des fichiers Markdown qui permettent un formatage assez poussé, tout en bénéficiant du versioning de Git.

Dans un README.md mettez :

  1. Une courte description du projet ;
  2. Les étapes pour lancer votre projet localement (utile pour l'autonomie des personnes) ;
  3. Les étapes pour configurer tous les outils nécessaires à l'environnement de production (ceux qui ne peuvent pas être configurés via du code) ;
  4. Quelques informations sur les bonnes pratiques à respecter pour contribuer au repository.
Exemple d'un README.md (source)

Sachez que si vous souhaitez faire des schémas de votre architecture (en UML ou pseudo-UML), l'idéal c'est aussi de les versionner. En plus vous pouvez utiliser l'outil draw.io directement dans l'éditeur de code Visual Studio Code, tout se fait au même endroit, c'est hyper pratique.

Exemple d'un schéma intégré à un README (source)

Si vous préférez définir vos schémas via du code plutôt qu'une UI, allez voir l'outil Mermaid.