jeudi 16 juin 2005

Guide utilisateur


GUIDE UTILISATEUR

Imaginez si vous auriez à apprendre linux ou oracle sans guide à l'usager. Vous sauriez sûrement décourager et vous auriez bien raison. Pour diverse raisons, nous sommes amenés à apprendre un nouveau logiciel. Souvent, il n'y a aucune documentation disponible pour nous aider à comprendre le logiciel. Il est alors beaucoup plus long à maîtriser un tel outil lors de cette situation. Lorsque vous développez un logiciel qui sera utilisé par plusieurs personnes, il est important de prévoir un document qui aidera l'usager à comprendre votre programme.

L'exemple qui vous sera montré est un logiciel que moi et mes coéquipiers avons développé pour la librairie Aby Yala (www.abyayala.com). C'était notre projet de fin d'études.

Section pouvant être incluse dans un guide à l'usager

Table des matières

La table des matières doit être incluse dans chaque division et sous division de votre documentation

Nouveauté du logiciel

Indiquez les nouveautés de la version du logiciel s'il existe plusieurs versions

Configuration requise

Indiquez la configuration minimale recommandée pour le logiciel

Manipulation du programme

Indiquez les étapes pour l'installation, l'exécution et la désinstallation de votre programme.
S'il existe plusieurs composants (librairie, dll, base de donnée....) externes nécessaires au bon fonctionnement de votre application,inscrivez les étapes précédentes pour les composants auxquels s'applique cette démarche

Description du programme

Inscrivez une description générale de votre application.

Outils de navigation et menu

Détaillez les outils de navigations et les menus s'il y a lieu

Fonctionnement du programme

Indiquez les étapes nécessaires pour effectuer des traitements. Donnez de l'information sur les options du programme. Les images facilitent l'apprentissage d'un usager.

Force du système

Identifiez les forces de votre programme, les petits plus de votre application

Glossaire

Prévoyez un glossaire si votre documentation contient des termes techniques qu'un usager ne pourrait comprendre.

Document word du projet disponible ici.

Aucun commentaire:

Publier un commentaire