Table des matières
Comment rédiger une bonne documentation?
Comment s’assurer de la qualité de la documentation?
- Elle doit être synchrone avec le code.
- Elle doit être écrite en même temps que le code.
- Elle doit être lisible à partir du code et de l’extérieur : c’est la multidiffusion.
Pourquoi faire une documentation?
Une bonne documentation permettra un gain d’autonomie et de vitesse d’apprentissage des nouveaux arrivants. L’équipe de développement sera plus polyvalente sur les domaines qu’elle peut traiter et il y aura moins de flou sur le fonctionnement du logiciel.
Quelle est la raison principale d’une documentation logicielle?
Bien que la raison principale d’une documentation logicielle est d’aider les utilisateurs à comprendre comment utiliser l’application, il y a aussi d’autres raisons, telles que l’aide à la commercialisation du logiciel, l’amélioration de l’image de la compagnie et plus encore, la réduction des couts d’assistance technique.
Comment aborder les besoins de la documentation?
Comprenez les besoins du public auquel la documentation est destinée. Dans la majorité des cas, les utilisateurs de logiciel ont peu de connaissances en informatique, mis à part les taches que les applications qu’ils utilisent leur permettent de faire. Il existe plusieurs façons de déterminer comment aborder leurs besoins dans votre documentation.
Quelle est la norme de la documentation?
Certains langages de programmation comme Java et .NET Framework (Visual Basic.NET, C#) ont leurs propres normes pour ce qui est de la documentation. Dans ces cas, suivez les normes pour déterminer combien de documents doivent être inclus avec le code source. Choisissez l’outil de documentation adéquat.
Quel est l’outil de documentation approprié?
Choisissez l’outil de documentation approprié. Les guides d’utilisation imprimés ou PDF peuvent être écrits avec un programme de traitement de texte comme Word ou un éditeur de texte sophistiqué comme FrameMaker, en fonction de leur longueur et de la complexité.