Discussion :

[HerQuLe]

Bonjour,

Je suis désolé si ce topic n'est pas a la bonne place mais a vrai dire je ne savais pas trop ou le mettre Et je pense que ca fait quand meme plus ou moins partie du "cycle de vie" du logiciel puisque ca fait partie de la documentation.



Voila nous avons réalisé un logiciel dans un cadre scolaire et celui-ci va probablement etre utilisé un jour, donc nous devons réaliser un manuel utilisateur. Seulement voila moi les outils de documentation (meme word etc) c'est vraiment pas mon fort et je me demande s'il n'y a pas des outils plus adaptés pour faire ce genre de choses.


On voudrait un résultat qui fasse un minimum pro, dans ce genre la:
http://www.ensg.ign.fr/FAD/FAD_PDF/c...toshop_6.0.pdf
Mais en beaucoup moins gros quand même

Je souhaite donc avoir une solution qui me permet de la meme manière que l'exemple d'avoir un menu avec une arbo sur le coté qui permette de naviguer facilement dans le manuel. Avec également la possibilité de mettre facilement des images, fonds etc...



Je voulais donc savoir, ceux qui ont deja eu cette tache a accomplir, quels sont les outils que vous avez utilisez? Word? OpenOffice? Acrobat PDF Writer? LaTeX? Autre?



Moi j'ai essayé de faire un truc avec OpenOffice mais je suis pas certain que ca soit le meuilleur outil pour faire des pdf de ce genre


J'hésites a me mettre au LaTeX, je m'y connais pas trop mais ca me semble etre une bonne solution (j'aime pas trop les éditeurs graphiques a vrai dire, y a toujours des trucs qui foirent dans tous les sens avec moi...). Vous en pensez quoi?



Désolé pour ce poste un peu noob mais je prefere demander quelques avis avant de perdre du temps pour rien.

[sevyc64]

Personnellement, pour ce genre de document, j'ai toujours utilisé Word, mais l'équivalent dans OpenOffice.Org (Write, je crois bien) doit tout aussi bien convenir.

Latex est apparement pas mal utiliser aussi pour la doc. Je ne le connais pas, donc je n'en parlerais pas.

Pour ce qui est du PDF, personellement je fais mon document avec des outils classique que je transforme en PDF par impression sur une imprimante PDF (et d'ailleurs, il y a longtemps que je n'utilise plus les outils Adobe, tant en création qu'en lecture, qui sont d'une lourdeur extreme et insupportable)

[hegros]

Bonjour,

Je suis désolé si ce topic n'est pas a la bonne place mais a vrai dire je ne savais pas trop ou le mettre Et je pense que ca fait quand meme plus ou moins partie du "cycle de vie" du logiciel puisque ca fait partie de la documentation.

documentation -> conduite de projet


une solution serait de faire des pages HTML c'est facile pour intégrer des images et avec un peu de css on peut faire des choses plutot jolies pour les menus par exemple et pour un document de guide utilisateur c'est interéssant


je ne te propose biensûr pas photoshop

[souviron34]

moi je combinerais les 2 :

une doc (Word), incluant les copies d'écran (éventuellement commentées) ET la séparation de cette doc en pages HTML...

[HerQuLe]

Ok merci

Je vais essayer de faire un truc correct


Par contre sous Word comment on fait pour avoir l'index sur le coté pour une navigation simplifiée? comme sur mon exemple quoi?

[exoseven]

Je vais prêcher pour ma paroisse mais tu peux essayer mon programme Help&Web qui permet de faire des aides htmlhelp (chm), html, PDF et rtf

[Invité]

Voila nous avons réalisé un logiciel dans un cadre scolaire et celui-ci va probablement être utilisé un jour, donc nous devons réaliser un manuel utilisateur. Vous en pensez quoi ?

La meilleure des documentations est une « documentation en ligne ». Une application qui n’évolue pas est une application « morte » qui n’a donc pas besoin d’être documentée. Une application « vivante », qui évolue donc, nécessite de faire évoluer parallèlement sa documentation, d'où un problème de synchronisation développements/documentation. Un logiciel dont l’ergonomie est bien conçue, intuitive, ne devrait pas nécessiter une documentation exhaustive, indigeste qu’en fin de compte, personne ne lit. Il y a une réalité dont il faut tenir compte, c'est que bien peu de gens prennent aujourd'hui le temps de lire, ne serait-ce que les notices d'installation des appareils ménagers.

Personnellement, je n’ai jamais proposé de documentation à mes utilisateurs. Lorsqu’ils me faisaient part d’une difficulté d’utilisation de mes logiciels, cela révélait un manque de pertinence de ma part dans mes choix de conception. Ce n’est pas par une documentation que j'apportais une réponse à leur incompréhension mais en revisitant mes développements pour leur proposer une dynamique conforme à leur réalité. Curieusement, cette absence de documentation a créé une dynamique de communication entre les gestionnaires dont j'ai usé et abusé. Chaque nouveau développement était immédiatement repéré par un/une gestionnaire qui me sollicitait aussitôt et transmettait l'information aux autres. Développer dans ces conditions a été un véritable bonheur pour moi comme pour les gestionnaires et les chefs de service, mais c'est une autre histoire...

Pour en revenir à la question, bien qu’ayant prévu une documentation en ligne sobre, digeste, pertinente, elle n’était pratiquement jamais consultée. Ceci pour dire que la question peut se poser de l’utilité de consacrer du temps à la réalisation d’une documentation « exhaustive », genre « Manuel d’utilisation ». Et je ne parle pas du coût papier, de la diffusion, etc.

Concrètement, mes utilisateurs se sont tous créé eux-mêmes leur propre documentation qu’il m’arrivait d’ailleurs de piller pour améliorer mes développements. Pour aller dans leur sens, mes applications leur permettaient d'imprimer une capture d'écran plus satisfaisante que le résultat d'un appui sur la touche « Impécr ». La seule formation que je dispensais concernait… l’utilisation des raccourcis-clavier : Ctrl/A, Ctrl/X, Ctrl/V, Ctrl/D, etc.

Concrètement encore, après 15 ans de développement « APL/AML » (Au Pied Levé/A Main Levée) et des applications enfin presque stabilisées (dans l’administration, les problématiques ne sont jamais vraiment stables), je me suis enfin posé la question de la documentation. J’en suis venu à imaginer une documentation « à postériori » à l’usage de l’utilisateur, du formateur et de l’informaticien. L’idée étant - côté informaticien - que cette documentation puisse servir de « Cahier des charges » pour de nouveaux développements par une méthode plus classique « Top-Down ».

Dans cet esprit donc, j’ai fait tout simplement le choix de PowerPoint qui me permettait facilement de créer des diapositives avec des captures d’écran commentées et d’insérer des liens vers des états PDF. PowerPoint étant très consommateur de mémoire, mais ludique, j’ai dû segmenter ma documentation en créant autant de PPT que de sous-menus reliés entre eux par des liens.

Concluant une démarche personnelle de développement « Bottom-Up/In-Situ », l’investissement « Documentation » m’a beaucoup intéressé, sauf qu’ayant atteint ma date de péremption… tout est parti à la poubelle.

Si mon cheminement interpelle quelqu’un, je peux proposer un échantillon de PPT téléchargeable sur mon espace Windows Live.

Enfin chacun a sa vision des choses que je respecte, adaptée à sa production logicielle et à ses méthodes de développement. C’était juste histoire de parler, d'apporter un écho différent et d’évoquer un souvenir qui s’estompe progressivement vers l’oubli.

[Xorangoutan]

J'aime ta réponse IFA2377.
Pour ma part, j'essaye de fournir 2 choses: un mode opératoire exhaustif construit à partir de wink puis exporté en pdf. Wink permet de créer assez rapidement une série de captures d'écran (manuels, par la saisie, par timer)
et une fiche d'aide qui rappelle, comme le dit Joel Robuchon, les points importants de la recette.
La fiche d'aide doit faire un format A5 recto/verso au maximum.

Cette construction en tout cas ne peut se faire qu'avec l'utilisateur.