La documentation des projets

La documentation d’un projet est très importante pour deux populations très distinctes : les utilisateurs de l’application, et les développeurs de l’application.

TIP

Les deux documentations essentielles

Chaque projet doit avoir 2 documentations, distinctes et mises à jour régulièrement :

• une pour les utilisateurs
• une pour les développeurs

TIP

La documentation pour le déploiement

Éventuellement une troisième documentation peut être présente pour ceux qui seront en charge du déploiement. Idéalement, elle devrait être simple et peut être contenu dans la documentation destinée aux développeurs.

La documentation pour les développeurs

Elle doit contenir :

• une liste des prérequis (OS et leurs versions, logiciels et leurs versions à avoir pour travailler sur le projet)
• la stack détaillée du projet
• un TL;DR avec comment lancer les tests, comment démarrer l’application
• une partie pour les nouveaux arrivants sur le projet (très important)
• les conventions à suivre pour ce projet (avec un rappel vers la présente documentation)

La documentation pour les utilisateurs

Cette documentation, la plupart du temps, s’adresse à un public non-technique. Veillez à prendre cela en compte en rédigeant la documentation.