exemple de manuel interactif pour l'application web [fermé]

Question

J'ai besoin d'écrire l'aide (par exemple, description du spectacle de ce que certains bouton fait) pour mon application web. Y a-t-il des bons exemples pour le faire?

Answer 1

J'ai trouvé l'aide dans le moteur de construction Hudson pour être très élégant et discret.

Vous avez une icône d'aide, vous cliquez dessus, le texte d'aide est expaned en ligne la page, vous cliquez à nouveau, il disparaît.

Essayez de commencer https://hudson.dev.java.net/hudson.jnlp et aller à http: // localhost: 8080 / configurer et cliquez sur les nombreux boutons sur le côté droit

(?).

Answer 2

Java Doc peut être utilisé pour extraire tous les commentaires incorporés à l'intérieur du java fichier de code

Answer 3

Jetez un oeil à JavaHelp. Émule le système trouvée dans les anciennes versions de Windows

Answer 4

Il est très moderne d'écrire la documentation dans un wiki. Il est facile de modifier, bien structurer etc.
Mais je déteste ça. Je déteste vraiment. Il est jamais bien structuré et facile à lire. Il y a beaucoup d'efforts que vous devez mettre dans un wiki pour le faire bien.

Je recommande donc d'utiliser un simple CMS. Non surpuissant, simplement modifier texte avec des liens. Vous avez la possibilité de l'intégrer dans votre webapp et il y a la possibilité d'extraire un fichier PDF de celui-ci.
C'est soigné pour offrir une aide en ligne pour l'impression, etc.

Answer 5

Je viens d'utiliser un bon vieux HTML / CSS - ce maintiendra les utilisateurs de comportement savent déjà dans un navigateur et vous devriez déjà avoir la feuille de style pour l'application de sorte que vous maintiendrez le L & F à travers les pages d'aide avec peu effort supplémentaire.

Jetez un oeil à l'aide sur Google Maps ( http://maps.google.co. Royaume-Uni / support / ) - des idées de mise en page, etc.

Une chose que j'ai remarqué quand je regardais les pages d'aide Google a été la recherche (pas de surprise là-bas), ce qui pourrait être un peu plus délicat - si votre site est face externe alors je mettre en œuvre ce avec le « site: < votre site > » mot-clé et utiliser la recherche Google. Si votre site est interne, vous devrez rouler votre propre recherche, mais cela ne devrait pas être trop dur et serait probablement tout à fait un sous-projet amusant.

Answer 6

Si vous utilisez PHP, jetez un oeil à phpDocumentor .

  

L'outil phpDocumentor est autonome   auto-Documentor similaire à JavaDoc   écrit en PHP.

Answer 7

Si vous êtes à la recherche d'un manuel utilisateur illustrant ce que chaque bouton, je l'ai trouvé à l'aide quelque chose comme debugmode Clin d'oeil ou Adobe Captivate utile pour enregistrer l'interaction de l'écran, puis le convertir en soit un film flash ou PDF.

Answer 8

En particulier pour Rails: http://github.com/darthapo/comatose/tree/master est un grand petit outil CMS que vous pouvez utiliser pour les systèmes d'aide incrustées.

Dans le cas contraire, http://tenderapp.com/ fonctionne bien comme une solution hébergée.