Bonjour, il y a quelques temps j'ai commencé mon travail de diplôme. Il nous est demandé d'écrire une documentation technique sur le programme développé, le problème est que c'est un exercice assez nouveau pour un projet de cette ampleur. Je me demandais donc si quelqu'un a des conseils voir mêmes des guides pour ce genre de rédaction?

Merci d'avance.

oui ça dépend du langage si t'es en java je crois que tu as des outils pour générer une javadoc par exemple

Le 03 juin 2015 à 17:30:35 dark_drow a écrit :
oui ça dépend du langage si t'es en java je crois que tu as des outils pour générer une javadoc par exemple

Oui ça c'est fait, mais ça ne couvre que l'analyse fonctionnelle (il me semble), une doc devrai être plus complète à mon avis

Quelle est la procédure d'installation ?
Quelle est la procédure de mise à jour ?
Y a-t-il des versions de technologies incompatibles ?
Quelle est la procédure pour allumer ?
Quelle est la procédure pour éteindre ?
Comment un développeur peut-il prendre le projet pour développer ?
Quels sont les pré-requis ?
Quelles sont les limitations techniques ?
Quel est le tag des versions dernièrement mises en production ?
Quel est le dernier environnement complet en production ?

Voici quelques pistes, et pour en trouver d'autres, suit le conseil de Hors-Charte (reformulé) : que voudrais-tu trouver et lire là-dedans ? Qu'est-ce qui est pertinent ? Qu'est-ce qui est strictement inutile ?