Bienvenue sur le forum !

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

Qt 5 : 5.8.0 - Qt Creator : 4.3.0 - Qt Installer : 2.0.3 - JOM : 1.1.2 - Qt Build suite : 1.7.0 - VS Qt 5 : 2.0.0

Outil pour générer la documentation d'un logiciel.

AKSAKS
October 2015 modifié dans Divers et inclassable
Bonjour,

Après quelque temps de silence, je reviens! En plus avec une question de la plus haute importance: Quels outils connaissez vous pour rédiger puis générer de manière efficace (les moins chronophages) et jolie (moderne, et pas dans le style moche des anciennes documentations) un manuel d'utilisation à un logiciel ?

Ah oui et bien sûr: J'aimerais que ce soit compatible si possible avec QHelpEngine, sinon ce n'est pas très grave. :)

Voilà voilà!

Réponses

  • Suffit de suivre les liens : http://doc.qt.io/qt-5/qthelp-framework.html
    Sinon, les "anciennes" doc ne font pas du moche ou du jolie, ils font ce qu'on leur dit (oui, le CSS par défaut n'est pas jolie, mais suffit de ne pas garder le CSS par défaut)
  • Mais j'ai lu cette ligne là dedans: "Building help files for the Qt help system assumes that the HTML documentation files already exist."
  • Et bien sûr je voudrais rédiger ladite documentation HTML avec le moins d'efforts possible avec un outil, un plugin LibreOffice ? Latex le fait ? etc...
  • Ok, j'avais oublié que ça se passait en 2 étapes. Donc doxygen ou qdoc pour la génération du html
  • Ah voilà ! Merci beaucoup! Du coup Qt prenait tout en charge. Super! Merci. :)
  • AKSAKS
    October 2015 modifié
    Ah ! Je me suis mal exprimé... Je voudrais pas générer la documentation au code source, mais à l'utilisation du logiciel ! :((

    Sinon, j'ai trouvé jusqu'ici MkDocs et Daux.io
  • Oui, pareil :) J'utilise doxygen (+ markdown) pour tout générer (doc du code, mais également les manuels).
    Mais tu peux utiliser n'importe quel générateur de HTML du coup. Les plus connus sont probablement markdown (avec pandoc, je te le conseille) ou Latex (mais beaucoup plus chi... a prendre en main). Sachant que pandoc peut générer a peut près tout (html, pdf, etc) à partir de n'importe quoi (doc, txt, markdown, etc), tu pourras tout faire avec ca
  • Je vois! J'aime bien markdown vu que c'est super simple à prendre en main, enfin pour ce qui est de la base.

    Du coup si je prends la route du markdown, imaginons que j'ai rédigé la documentation avec la numérotation qui va avec. Je traduis ça en HTML et je peux utiliser QHelpEngine dessus ?

    Merci!
Connectez-vous ou Inscrivez-vous pour répondre.