Comment écrire la documentation du projet

Question

Je viens de terminer un projet relativement petit (~ 3000 lignes de code dans plusieurs modules) et on m'a demandé de produire un document pour le projet. Je n'ai aucune idée de comment s'y prendre car j'ai surtout écrit du code pour d'autres programmeurs auparavant. Est-ce que je décris chaque module, fais des diagrammes UML pour chaque objet, développes-tu simplement mes commentaires? Y a-t-il un modèle que je peux utiliser pour cela? Si quelqu'un a dû faire une documentation standard j'apprécierais votre aide/pointeurs.

Answer 1

Il n'y a pas beaucoup de documentation "standard"; Les documents API de type "Javadoc" sont à peu près aussi proches que possible. Obtenez des exigences plus solides. De quel type de document votre client a-t-il besoin? Les diagrammes UML pour tous vos cours sont un bon exercice, et parfois utile, mais votre temps peut être mieux consacré à de futurs projets.

Answer 2

Au minimum, vous devez documenter

• comment construire le logiciel
• comment l'installer
• un « manifeste » des fichiers et les outils nécessaires
• notes de version: ce qui a changé à partir de la version précédente publiée
licence
• et les informations de copyright

Ensuite, en fonction de la façon dont le logiciel est utilisé, vous pouvez

• Manuel de l'utilisateur
• documentation API

Answer 3

Vous pourriez faire bien pire que l'examen des données DOD-STD-2178A Point Descriptions pour le document de conception de logiciel et le document de description de version.

Le SDD décrit la conception du logiciel. Le VDD décrit l'emballage, y compris comment l'installer (décompresser, compiler, charger, configurer).