Types de documentation du logiciel

Table des matières:

Anonim

Si vous avez déjà vu un répertoire d’ordinateur sur un lecteur réseau de votre société nommé "documents logiciels" ou "guides logiciels", puis consulté les documents que vous aviez l’autorisation de consulter, vous avez probablement compris le nombre de documents et de types de documents logiciels. nombreux. Il semblerait également que certains documents classés dans une catégorie s’appliquent également à d’autres catégories. Les documents logiciels sont utilisés à chaque étape du cycle de vie d'un logiciel typique. C'est donc un bon endroit pour étudier le type de documents créés.

Proposition

Une proposition de logiciel spécifie la configuration système requise pour le logiciel et définit l'objectif du logiciel et les problèmes qu'il résout. Il précisera également la durée estimée du projet de logiciel et d’autres facteurs ayant une incidence sur la proposition.

Étude de faisabilité

L'étude de faisabilité a généralement lieu au début du projet. Cette étape détermine si l’installation logicielle répond aux besoins du client. Le résultat d'une étude de faisabilité détermine si un projet sera réalisé ou non.

Analyse des besoins

Une analyse des exigences permet de traduire les exigences de l’entreprise en solutions logicielles automatisées. Un consultant externe ou la direction de l'entreprise effectue généralement cette tâche. Les exigences traduisent les exigences commerciales en spécifications réelles pour le matériel, les logiciels et les composants.

Documents de conception

Les documents de conception fournissent la base pour que le développement logiciel commence au niveau technique. Comme son nom l'indique, un certain nombre de conceptions graphiques et textuelles pour des bases de données, des interfaces, des communications, des développements Web et d'autres aspects du logiciel seront conçus avant que le codage puisse commencer.

Documents de codage

Les documents de codage font référence au code source utilisé pour la programmation du logiciel. Le code peut être écrit dans un nombre quelconque de langages informatiques disponibles, y compris Java, C ++, PHP et des centaines d'autres langages informatiques en fonction du système utilisé.

Documents de test

Les équipes de test et les développeurs créent des documents de test à différentes étapes du cycle de vie du logiciel. Les développeurs créent des documents de test unitaire pour leur propre code. L'équipe de test ou d'autres personnes non associées directement au code se chargent des tests d'intégration et des tests des exigences métier.

Guides de l'utilisateur et marketing

Les guides de l'utilisateur fournissent des instructions sur le fonctionnement du nouveau logiciel. Si le système est volumineux et complexe, les guides de l'utilisateur sont généralement complétés par des cours de formation officiels pour le personnel. Les documents marketing illustrent les avantages du nouveau système logiciel pour les clients potentiels.

Licences de logiciel

L'émission de licences de logiciel rend l'utilisation du logiciel légale pour l'utilisateur final. Les utilisateurs utilisent des logiciels selon les termes d’une licence de logiciel émise par la société qui les a créés. Tous les logiciels ne sont pas soumis à des termes de licence stricts, et cela est particulièrement vrai dans le cas de l'open source. Généralement, les systèmes logiciels ont une forme de document de licence en place spécifiant comment et où le logiciel peut être utilisé.