Discussion :

[fcbouan]

bonjour,

je voudrais savoir quels logiciels open source ou non utilise les ingénieurs ou développeurs confirmés qui postent sur ce forum pour documenter et archiver leurs sources et projets de programmations au sein de leur entreprises ?
J'aimerai ne pas me limiter au commentaires succints dans mon code entre 2 /* */ ou un simple .doc ça ne fais pas trés sérieux

vous utiliser des logiciels de modélisation UML, de gestion historique, etc ... ?

j'aimerai connaitre les bonnes pratiques qui se conduit en milieu professionnel pour tout ce qui est documentation.

Merci de m' éclairer et m'indiquer vos outils ce qui pourrais m'inspirer

[Mac LAK]

Gestion de configuration : serveur CVS + client WinCVS (freewares). Intégration aux chaînes de développement assez nulle, mais on s'y fait.
Documentation automatique : Doxygen (freeware), à condition de réaliser des templates en accord avec la charte graphique définie (c'est pas dur, mais ça demande de la rigueur).
Documentation générale : ISO 9001 minimum, en général au format Word (ou tout autre traitement de textes permettant l'insertion de schémas, et connaissant la notion de modèle de document).
Modélisation formelle : dépend des projets, parfois même rien du tout (pour une librairie interne de 200 lignes, c'est pas la peine de sortir UML !!)

Les documents Word, ça peut faire extrêmement sérieux, du moment que :
- Les documents sont correctement présentés et homogènes (charte graphique),
- Le nom, le type et la quantité de documents sont corrects (spécifications, conception, tests, validation, éventuellement spécifications de besoins, CDC, cahier de recette, etc...)
- Chaque document est correctement structuré (norme ISO 9001), référence bien les documents de référence et les documents dépendants, que tout est versionné et possède une liste des modifications depuis la version initiale du document.
Demande à un ingénieur qualité de t'expliquer, il le fera bien mieux que moi. Mais en gros, un document est "pro" parcequ'il a l'air pro : pas de fautes d'orthographe ou de grammaire, bonne expression écrite, clarté, typographie propre, etc...

Si j'avais le choix (et le budget), je prendrais certainement d'autres outils, mais ceux-là ne "coûtent" presque rien, juste le temps de maintenance et de rédaction : c'est intéressant pour un free-lance ou une PME/PMI... Les outils qui me plairaient coûtent un peu plus de cent mille euros au total, c'est pas franchement donné non plus ! ;-)

[fcbouan]

ok merci bcp pour ta réponse !!

[Luc Hermitte]

(Mauvais forum...)
Au boulot, on a Rose (un vieux un peu instable), CVS et doxygen, et word 2000 (même version que le client). Certains passent par wincvs+samba, je code directement sous nix avec gvim qui encapsule les appels CVS.

Certains méritent d'être reconsidérés pour de futures versions. Notament la gestion des versions. Je trouve que cela nous demande encore trop de boulot sans parler des problèmes de sauts de lignes (et donc de merges) induits par ceux qui passent par winCVS.

[filtrac]

Bonjour,

Doxygen et Word.