Quels outils votre équipe utilise-t-elle pour rédiger des manuels d'utilisation?

Question

Les demandes de base sont:

• lisible par l'homme / format texte (pour faciliter le contrôle de version)
• en ligne (collaboration)
• faciliter la mise en forme (markdown ok, html, c'est trop)
• la stricte mise en forme (ainsi les auteurs de ne pas inventer de nouveaux types de titres, balles etc.)
• exportable en PDF, HTML
• facile de sauvegarde et de déploiement (pour nous permettre de "déployer" pour les clients du site comme lecture seule version)

Nous réfléchissons à l'aide d'une sorte de moteur de wiki, mais il serait nécessaire d'utiliser les fichiers pour le stockage ou ont d'autres moyens de "déploiement" de la clientèle et d'être facile à installer/maintan. En outre, il devrait être gratuit / pas cher (confluence est trop cher)

Toutes les suggestions?

Edit: je ne suis pas à la recherche d'outils pour documenter le code, nous en avons couverts à l'aide de Châteaux de sable.

Answer 1

Latex

Answer 2

Bien qu'il ne peut pas répondre à toutes vos demandes, DokuWiki peut-être la peine de prendre un coup d'oeil.

Comme avec les autres wikis, il a une syntaxe simple, et a le contrôle de version pour suivre les révisions, génère une table des matières, et une recherche de texte intégral fonctionnalité qui peut être utile pour un système d'aide.

Vous voudrez peut-être évaluer la fonctionnalité de liste pour voir si elle va répondre à vos besoins.

Aussi, il semble aussi être une bonne collection de disponnible plugins. Bien que je n'ai pas utilisé DokuWiki ou de ses plugins, il semble y avoir des plugins disponibles pour l'export PDF ainsi.

Answer 3

Pour notre API, nous utilisons Doxygen , ce qui est génial.

Answer 4

Pandoc est un fantastique outil pour la conversion entre les différents formats de balisage. Nous écrire des documents markdown et l'utilisation Pandoc pour convertir vers d'autres formats.

À partir de la pandoc site:

Si vous avez besoin de convertir des fichiers d'un balisage format dans un autre format, pandoc est votre couteau suisse. Pandoc pouvez lire markdown et (sous-ensembles) de reStructuredText, textile, HTML et LaTeX, et il peut écrire du texte simple, markdown, reStructuredText, HTML, LaTeX, Contexte, PDF, RTF, XML DocBook, OpenDocument XML, ODT, GNU Texinfo, MediaWiki balisage, textile, groff homme pages, Emacs org-mode, ebooks EPUB, et S5 et Slidy diaporama HTML. PDF de sortie (via LaTeX) est également pris en charge avec le markdown2pdf wrapper script.

Pandoc obtient des points supplémentaires pour être open source et à l'écrit dans la chaleur qui est Haskell ;)

Answer 5

Nous utilisons l' aide et le manuel pour le manuel et le fichier d'aide. Il n'y a pas d'export html, mais il fournit de l'aide html, winhelp, pdf et quelques autres formats.