Bienvenue sur le forum !

Si vous souhaitez rejoindre la communauté, cliquez sur l'un de ces boutons !

Qt 5 : 5.9.1 - Qt Creator : 4.3.1 - Qt Installer : 2.0.3 - JOM : 1.1.2 - Qt Build suite : 1.7.0 - VS Qt 5 : 2.0.0

Qu'utilisez-vous pour générer la documentation utilisateur

Bonjour à tous,

Je voulais ouvrir ce post pour voir quelles étaient les différentes voies pour faire une doc intégrable dans un logiciel pour l'utilisateur.
Au niveau de la documentation de l'API j'utilise Doxygen, mais le rendu HTML n'est peut-être pas le mieux pour un manuel d'utilisation.
Je pensais faire des pages html perso + un webView.
Le top serait peut-être un truc du genre chm sous Windows, avec index de recherche (mais multi plateforme).

Avez-vous d'autres idées ?

Réponses

  • Heu, Doxygen, c'est pour la doc technique, non ?
  • Bonsoir !
    babaOroms said:
    Je pensais faire des pages html perso + un webView.
    C'est ce que j'ai fait, je trouve que c'est la solution qui a le meilleur "coef" Esthétique de la mise en page * Facilité de maintenance.
  • Merci PapaJaac, je m'oriente dans cette voie.
    @Dergen : Doxygen est plus dédié à générer la documentation du code.
    Au niveau de la documentation de l'API j'utilise Doxygen, mais le rendu HTML n'est peut-être pas le mieux pour un manuel d'utilisation.
    ;)
  • Ok, perso et depuis longtemps, j'ai fait le choix (quelque soit le langage) de faire la doc utilisateur en HTML et que je stocks dans les ressources du programme.
  • Très bonne idée.
    Je vais implémenter ça et voir si je peux à l'aide de la touche F1 ou autre (car je suis aussi sous MacOS) cibler la doc selon la fonction utilisée sous le logiciel.
  • Pour un grosse appli avec une aide riche et interactive il y a Qt Assistant. Je n'ai pas testé.
  • De mon coté, rien ! XD

    Mais il faudra que je m'y mette (pas), du HTML dans l'aplli elle même est l'idée que j'ai eu, mais bon, trop lent pour que sa soit complet.
  • Bonjour,

    Nous utilisons Dokiel pour générer la doc utilisateur. L'outil a sans doute quelques défauts, mais il répond correctement à nos besoins (mis à part pour l'internationalisation).

    Notre doc est générée dans les 3 formats suivants:
    - "mini-site" html,
    - PDF
    - et CHM.

    Si ça peut intéresser qqun, c'est ici: http://scenari-platform.org/projects/dokielguide/fr/pres/co/archives.html
  • Bonjour,
    j'y jette un œil de ce pas. Merci.
Connectez-vous ou Inscrivez-vous pour répondre.