Accéder au contenu principal

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.
Libellés :

Commentaires

Enregistrer un commentaire

Posts les plus consultés de ce blog

Toshiba AC100 et Android 4

Toshiba AC100 est un smartbook. Toshiba est la seule grosse entreprise qui a commercialisé un smartbook, malgré que plusieurs autres en aient présenté. Un smartbook est similaire à un netbook (taille) en plus d'avoir des caractéristiques souvent proche à un mobile (GPS, 3g, processeur ARM, autonomie). Le Toshiba AC100 utilisait le système d'exploitation Android en version 2.1. Toshiba a effectué une mise à jour Android 2.2. Il a arrêté la commercialisation et le support de cette machine. L'appareil ayant un bon rapport qualité/prix, la communauté le prit en charge. Il est possible d'installer une version beaucoup plus récente d'Android telle que la 4.1. La rom alternative Cyanogen a été utilisée pour ce portage. Les procédures citées ont été faites sous Linux.  Sous Windows, il faut télécharger une version de nvflash pour ce système. Préparation Télécharger les fichiers: cm_ac100-ota-eng.cm10-beta2.zombah.zip recovery.ac100-cm10_beta2.img via ce...
36 commentaires
Lire la suite

Spring data jpa et Hibernate’s Warning “firstResult/maxResults specified with collection fetch”

Nous verrons dans cet article comment corrigé le problème  Hibernate’s Warning “firstResult/maxResults specified with collection fetch” qui peut survenir lorsqu'il y a un fetch d'effectuer et qu'il y a du paging. Nous utiliserons spring data jpa. Détail structure Imaginons une relation 1 à plusieurs Lorsqu'on obtient un parent, on désire obtenir aussi sa liste d'enfants. En sql, il y aurait une jointure à effectuer. Il est question d'une recherche avancé où on pourrait recherche par plusieurs critères. Spécification Création d'une spécification pour construire une requête dynamique @Component public class ParentSpecification {     public Specification<Parent> recherche(RechercheParent recherche) {         return (root, cq, cb) -> {             Join<Parent, enfant> enfantJoin;              List<Predicate> rootPredicates = new ArrayList<>();       ...
Enregistrer un commentaire
Lire la suite

Migration d’une application Spring Boot 2.2 vers Spring Boot 4.0 : retour d’expérience concret

 En 2019, nous avons développé une application métier basée sur : Java 8 Spring Boot 2.2.7 Gradle 6.6.1 Thymeleaf Bootstrap 4.3.1 Environ 40 000 lignes de code Java Fin 2025, voici un retour d’expérience concret sur la migration vers : Java 25 Spring Boot 4.0.1 Gradle 9.2.1 La partie thymeleaf, n'a pas été touché, il y a quelques warning concernant l'obsolescence de certain commande tel que th:include. Une migration plus rapide que prévu Un point important : en moins de 30 minutes, l’application démarrait sur la nouvelle stack. Évidemment, "ça démarre" ne veut pas dire "tout fonctionne", mais ce premier jalon est très révélateur : la base Spring Boot reste solide les outils de migration sont matures la dette technique était maîtrisée Les changements majeurs rencontrés De javax.* à jakarta.* C’est probablement le changement le plus visible. Tous les imports javax.* doivent être migrés ve...
Enregistrer un commentaire
Lire la suite