Discussion :

[sylvain1984]

Bonjour,

Désolé de poser cette question transverse au développement ici, mais je n'ai pas trouvé mieux sur le forum.

J'ai à rédiger le manuel d'un logiciel écrit en C++/Qt. Les utilisateurs potentiels sont plutôt âgés.

Avant de me lancer en ODT ou en Latex, j'aimerais savoir s'il existe des bonnes pratiques, voir des outils, pour faire ça ?

Idéalement, le manuel utilisateur pourra être ouvert depuis le menu "Aide" du logiciel. Il devra également pouvoir être imprimé.

Merci !
Sylvain

[umfred]

Le plus simple je pense c'est d'avoir au final un PDF.
Et dans le logiciel penser aussi à toutes les aides contextuelles éventuellement possibles (placeholder, infobulles par exemple)

Dans le manuel, privilégier les captures écrans éventuellement annotées (ou renvoyant à des explications) (après ça dépend du logiciel à documenter bien évidemment)

Après, il existe des logiciels d'aide à la création d'aide comme HelpNDoc (gratuit pour utilisation personnelle, mais payant sinon) (c'est un des logiciels qui ressort d'une recherche google)

[sylvain1984]

Bonjour,

(c'est un des logiciels qui ressort d'une recherche google)

Merci umfred. Bien sûr j'ai cherché sur le net. Mais il est maintenant trop courant d'obtenir une liste de sites proposant "les 15 meilleurs solutions pour...". Au final on ne s'y retrouve plus car tester chaque logiciel est impossible, les sites ne sont pas d'accord entre eux et surtout ils ne donnent pas le retour et les conseils utilisateur qu'il serait possible de lire ici.

J'ai regardé HelpNDoc et il a l'air effectivement très bien, mais pour Windows, alors que je suis sous Linux.

[gabriel21]

Si tu es sous Linux, je te conseillerais d'utiliser Latex et pandoc pour générer un Odt ou Docx, voir du HTML et epub. Pour l'epub, tant que tu n'as pas de mise en page trop complexe, cela fonctionne plutôt bien.

[sylvain1984]

Merci #Gabriel21,

Effectivement, je suis bien parti avec Latex et , après recherche, la classe Refman qui répond au besoin pour le moment.

Je pense qu'il existe un certain nombre de classe comme celle-ci et j'ai cherché un peu sur le net s'il existe une présentation comparée de ces classes. Hélas je n'ai pas trouvé...