L'importance de la documentation du logiciel

Définition de la documentation du logiciel

Les manuels techniques, manuels d’utilisation et autres instructions qui facilitent l’utilisation et l’exploitation d’un logiciel ou de services constituent la documentation du logiciel, qui peut inclure (si nécessaire) le code source, les codes d’erreur et leur signification. Il peut exister sous forme électronique, sous forme de fichier PDF ou CD, ou sous forme de livre.

Normes pour la documentation du logiciel

L’Institut de génie électrique et électronique (IEEE) a conçu des normes pour la documentation de l’industrie du logiciel. Il s'appelle IEEE 1063-2001, "Standard pour la documentation utilisateur du logiciel" et détaille le contenu, l'architecture et l'importance d'un manuel de documentation du logiciel. L’Organisation internationale de normalisation et la Commission électrotechnique internationale (ISO et CEI, idem) ont également établi des normes pour la documentation des logiciels. Leurs normes sont appelées ISO / IEC 18019-2004 et ISO / IEC TR 9294. Elles traitent de la gestion de la documentation et des logiciels, respectivement. Chacune de ces normes souligne que la documentation fait partie intégrante du cycle de vie du logiciel.

Fonctions de la documentation du logiciel

Tous les processus de cycle de vie des logiciels dans le développement d'un logiciel sont enregistrés en tant que documentation. La documentation sert d’information écrite sur la définition des exigences, les spécifications générales du système, la spécification de chaque composant et des plans de test et de maintenance complets. Les outils de gestion de la configuration sont également très utiles dans la documentation du logiciel.

Documentation logicielle pour les développeurs

L'importance de la documentation pour les développeurs réside dans le fait que la première contient des informations sur les opérations du système logiciel. Ces informations permettent la reproduction du logiciel ou son adaptation pour la maintenance. Le type d'informations documentées vaut généralement beaucoup pour l'éditeur de logiciels. De telles informations pourraient être perdues si elles ne sont pas documentées, car les développeurs vont et viennent.

Documentation du logiciel pour les utilisateurs finaux

Les manuels de l'utilisateur final facilitent l'interaction de l'utilisateur avec l'ordinateur. Un manuel de formation est un exemple de manuel orienté utilisateur. Il réduit le temps d'apprentissage nécessaire à une utilisation productive du logiciel, ce qui permet à l'utilisateur final d'économiser beaucoup d'argent. Les documents de l'utilisateur final peuvent également être un manuel de référence, décrivant en détail le fonctionnement du système, ou un guide pour les administrateurs système, décrivant en détail le fonctionnement et la maintenance du système.

Des Articles Intéressants