documentation du logiciel imprègne le cycle de vie du logiciel . C'est la partie visible du processus du logiciel. Sans cela , le logiciel ne peut pas être maintenue. Sans elle , les utilisateurs ne peuvent pas s'entraîner et ils ne peuvent pratiquement pas utiliser le logiciel . Sans elle, les nouveaux développeurs auraient à réinventer la roue dans le développement de logiciels . Documentation du logiciel est la manifestation la plus importante du logiciel . Il est le guide à travers le labyrinthe de logiciels. Définition de la documentation du logiciel
manuels techniques , manuels d'utilisation et autres instructions qui facilitent l' utilisation et le fonctionnement d'un produit ou des services logiciels constituent la documentation du logiciel . Cette documentation peut inclure le cas échéant, le code source , les codes d'erreur et leur signification. Documentation du logiciel peut également exister en format électronique , sous forme de fichier PDF, comme un CD ou un livre.
Software Documentation Standards
l'Institut de génie électrique et électronique (IEEE ) a conçu des normes pour la documentation du logiciel de l'industrie du logiciel . Appelé IEEE 1063-2001 , "Standard pour la documentation de l'utilisateur du logiciel ,« Ce document détaille le contenu, l'architecture et l'importance d'un manuel de documentation du logiciel. L'Organisation internationale de normalisation ( ISO) et la Commission électrotechnique internationale (CEI) ont également établi des normes pour la documentation du logiciel . Leurs normes sont appelées ISO /IEC 18019-2004 et ISO /IEC TR 9294 . Ils abordent la documentation du logiciel et de sa gestion , respectivement. Chacune de ces normes souligne que la documentation du logiciel est une partie intégrante du cycle de vie du logiciel .
Fonctions du logiciel Documentation
Tous les processus du cycle de vie du logiciel dans le développement d'un logiciel sont enregistrés comme documentation du logiciel. Documentation du logiciel sert information écrite sur les définitions des exigences , spécifications globales du système , les spécifications de chaque composant et le test complet et les plans de maintenance . Outils de gestion de configuration sont également très utiles dans la documentation du logiciel .
Software Documentation pour les développeurs
L'importance de la documentation du logiciel pour les développeurs de logiciels réside dans le fait que la documentation du logiciel contient des informations sur les opérations du système logiciel. Cette information permet de reproduire le logiciel ou l'adapter à maintenance.The type d'information documentée est généralement de plusieurs millions à la société de logiciels . Cette information pourrait être perdue si elle n'est pas documentée que les développeurs vont et viennent.
Software Documentation pour les utilisateurs finaux
Software Documentation aide les utilisateurs finaux apprécient le logiciel plus rapidement. manuels utilisateur final
favoriser l'interaction de l'utilisateur final avec l'ordinateur. Un manuel de formation est un exemple d'un manuel orienté vers l'utilisateur . Il réduit le temps d'apprentissage à l'utilisation productive du logiciel , économisant ainsi l'utilisateur final millions de dollars. Documents utilisateur final peut également être un manuel de référence qui décrit en détail le fonctionnement du système ou le Guide de l'administrateur système qui explique en détail comment exploiter et entretenir le système .
