[Qualité]Ecrire une documentation.

**berceker united** · 21/08/2006, 15h18

Bonjour.

Actuellement, je suis en train de faire une application web. Mais dans l'idée je voulais concevoir une doc en même temps que termine un module. Cette doc sera destiné à deux types d'utilisateur. Une pour l'utilisateur via HIM et le développeur.
Coté HIM je voulais faire deux types de doc. L'une sur l'interface concerné c'est à dire que si la personne à une doc associé au module en cour. Une autre doc utilisateur à un niveau plus haut c'est à dire générique mais qui reprendra celle de détailles des module.

Coté développeur je ne sais pas trop jusqu'ou aller mais j'ai les moyens de montrer : MCD, Diagramme de classe, Doc des classes via php doc, doc technique pour comprendre comment l'application tourne donc schéma, diagramme fonctionnelle etc. Doc sur la base de données. Chaque table et champs, triggers, fonctions sont documentés.
Je voulais savoir si c'est bien, s'il manque quelque chose ? Y a t'il une manière de faire.

En faite, mon but c'est que je ne veux pas que le développeur passe par où je suis déjà passé. C'est à dire qu'il y a un mec qui te dit "tien regarde comment ça marche" et que la doc soit top Freestyle, de passer du temps à cherche à comprendre. Je suis passer par là sur Os Commerce ou un autre développeur qui pensait savoir faire de l'objet mais c'étais que du caca faisant des bulles

.
J'aurais besoin de vos conseille. Merci.

PS: Je ferais un effort particulier sur l'orthographe, promis

**Matthieu Brucher** · 23/08/2006, 10h46

Pour le développeur, je fais en général une doc Doxygen bien complète, description de chaque fonction, préconditions, postconditions, ... et en plus j'ajoute l'adresse des documents externes nécessaires.
Pour la doc de l'utilisateur, au boulot on a prévu de prendre un Wiki, par exemple.

**berceker united** · 23/08/2006, 10h56

Envoyé par Miles

Pour le développeur, je fais en général une doc Doxygen bien complète, description de chaque fonction, préconditions, postconditions, ... et en plus j'ajoute l'adresse des documents externes nécessaires.
Pour la doc de l'utilisateur, au boulot on a prévu de prendre un Wiki, par exemple.

Sympa l'idée d'utilisation du wiki car ainsi je ne serait pas seul maitre à bord pour l'édition de la doc. Mon application sera gratuite et aurait souhaitez créer une petite communauté de personnes créant des contributions donc le wiki donne des opportunité.
Merci pour l'astuce

Autre question : y a t'il une methode que vous utilisez y a t'il un standard, regle, ... que vous connaissiez ? Est ce que mes 3 types de doc paraisse juste ou non?