Documentation de développement dans les projets logiciels

1. Introduction

• Signification et objectif de la documentation de développement : Comprendre le rôle crucial de la documentation dans la gestion de projets logiciels et la communication interne au sein des équipes.
• Documentation dans le cycle de vie du logiciel : La place de la documentation tout au long du cycle de vie, depuis la conception initiale jusqu’à la maintenance post-lancement.
• Exigences légales et normatives : Exploration des exigences juridiques et des normes en vigueur qui régissent la documentation logicielle.

2. Documentation produit pour chaque phase du cycle de vie (selon développement classique ou agile)

• Planification : Documentation du projet, définition des processus de travail.
• Analyse des exigences : Création de diagrammes de cas d’utilisation, spécification des exigences, spécification fonctionnelle, user stories avec critères d’acceptation.
• Conception et conception : Description de l’architecture, diagrammes de classes et de séquences.
• Implémentation : Documentation du code (ex : commentaires dans le code, directives pour les développeurs), documentation API, documentation interactive pour les utilisateurs et développeurs.
• Tests : Documentation des tests, scénarios de test, et résultats attendus.
• Maintenance et développement ultérieur : Documentation des problèmes rencontrés, des modifications apportées, et des évolutions.
• Du développeur à la documentation utilisateur : Comment la documentation évolue pour être comprise et utilisée par les utilisateurs finaux.

3. Conception des documents

• Aides à la structure et à l’orientation : Structurer les documents de manière claire pour qu’ils soient utiles à différents intervenants.
• Terminologie et textes : Utilisation d’un langage clair et compréhensible, règles de rédaction efficaces.
• Unités d’information sous forme de sujets : Organisation des documents en unités d’information cohérentes, telles que des tâches, concepts et références.

4. Création et gestion de la documentation

• Balisage des métadonnées : Structuration et indexation des informations pour une recherche efficace.
• Présentation des outils éditoriaux : Introduction à des outils comme Doc as Code, Wikis, et autres pour créer et maintenir la documentation.
• Modèles, gestion de documents : Utilisation de modèles pour garantir la cohérence, gestion de versions et flux de travail pour la création et l’archivage des documents.