Welche Software um ein Handbuch zu erstellen?

[rapante]

Wir sind gerade dabei auf helpndoc umzusteigen.

Help & Manual ist auch sehr interressant - für unsere Zwecke aber leider zu teuer.

[MichaelT]

Wenn dir Lyx nicht antust, dann bleibt dir Help and Manual.

Die Editoren aus dem Umfeld Authoring als Drama Queen, Scrivener, Patchwork, Stylewriter, Manuskript usw... sind eher sehr speziell und doch auch ganz gut. Mit Doku haben die nichts zu tun . Im Moment läufst du mit so einem Zugang eher Gefahr als Tante Droll unterzugehen, du alter Wild-West Poet.


Patchwork bspw. erlaubt dir Szenen zu erstellen usw... Wenn du ein Handbuch spannend und mitreißend willst gestalten, warum nicht?

Bei der technischen Dokumentation gibt es Sonderlösungen noch und nöcher für Screenshot getriebene Zugänge die teils starkt automatisiert einfach das ganze Programm oder die Website durchgehen. Für solche Anwendungen hilft eher Snagit und eine Art Mind Map mehr in Ergänzung zum Text.

Sobald die Doku ein wenig technischer wird und mehr Wort als Bild beinhaltet, dann landest du bei Help and Manual.

Sobald du English schreibt würde ich sogar Ergänzungen ala. After The Deadline & Friends in Erwägung ziehen. Das schönste Manual hilft nichts wenn der Content keinen interessiert.

Zitat von Codehunter:

Moin!

Welche Software nutzt ihr zum Erstellen von Handbüchern für Anwender? Ich rede jetzt nicht von Quellcodedokumentation sondern dem Benutzerhandbuch. Ich habe mir z.B. schon Papyrus Autor angeschaut, allerdings nicht dediziert für die Ausgabe von Hilfeformaten wie .CHM gedacht. Gefällt mir eigentlich sehr gut, vor allem wegen der im Vergleich zu Office-Lösungen besseren Layout- und Rechtschreibunterstützung. Allerdings scheint die Firma dahinter in Schwierigkeiten zu sein, denn es gelang mir über Wochen nicht, auf den gegebenen Wegen etwas zu bestellen oder Kontakt aufzunehmen.

Dann wäre da noch Help + Manual von EC Software. Das scheint sogar in Delphi geschrieben zu sein. Da macht die Webseite an sich schon den Eindruck, irgendwie veraltet zu sein (die Rede ist oftmals von Office 2013 oder Delphi XE6). Der Eindruck kann täuschen, deswegen ja die Frage nach eurer Meinung.

Was ich mir irgendwie nicht antun möchte ist LaTeX, zu viel Einarbeitungszeit, nicht intuitiv, schon gar nicht im Team mit handelsüblichen Büroangestellten.

Grüße
Cody

[Codehunter]

Zitat von Uwe Raabe:

Von mir auch ein klares Bekenntnis zu Help & Manual!

In meinem Anwendungsbereich muss ich fast identische Handbücher/Online-Hilfe für verschiedene Programm-Brandings erstellen. Da kommt mir die Variablen-Technik, das Handling der Screenshots und die Verwendung von Skins sehr entgegen.

Als weiteren Pluspunkt muss die Verwaltung mehrerer Sprachversionen des Handbuchs lobend erwähnt werden. Insbesondere das Synchronisieren von Änderungen und Ergänzungen ist schon sehr komfortabel.

Also wenn Uwe das sagt, muss was dran sein Beherrscht die Programmoberfläche eigentlich Lokalisierung? Die Webseite usw. ist alles Englisch. Mir persönlich wäre das ja Wumpe, aber es sollen ja noch andere damit arbeiten.

Und kann Help + Manual auch Teilexport? Also wenn man verschiedene Editionen seines Programms verkaufen will und dann keine Dokumentation von Programmteilen ausliefern will, die als solches nicht im Lieferumfang sind.

[hans65]

Wir benutzen zwar auch Help&Manual und sind damit auch zufrieden, aber trotzdem noch zwei weitere Gedanken:

1. Die Software Helpinator "http://www.helpinator.com/" ist vermutlich ähnlich wie HelpNDoc, hat aber noch einige weitere Ausgabeformate (z.B. QtHelp, OracleHelp, JavaHelp).

2. Mit einem Web-basiertes Wiki wie MediaWiki oder DokuWiki können sich verschiedene Autoren beteiligen. Die Einarbeitung in MarkDown ist nicht zu kompliziert. Konvertierungen nach Pdf und Doc sollen auch möglich sein. LibreOffice stellt sein Helpsystem gerade vom bisherigen xml-System hierauf um und Embarcadero arbeitet ja schon länger mit MediaWiki.

Andreas

[KodeZwerg]

Zitat von Codehunter:

Beherrscht die Programmoberfläche eigentlich Lokalisierung?

Hersteller sagt:

Zitat:

Installer includes English and German UI

[mkinzler]

Wobei Installer nicht das eigentliche Programm ist. Es geht auch eher darum einfach mehrsprachige Dokus zu erzeugen.

[Uwe Raabe]

Zitat von Codehunter:

Beherrscht die Programmoberfläche eigentlich Lokalisierung?

Man kann zwischen Englisch und Deutsch umschalten. Wenn das Windows auf Deutsch steht, wird das als Default auch eingestellt.

Zitat von Codehunter:

Und kann Help + Manual auch Teilexport? Also wenn man verschiedene Editionen seines Programms verkaufen will und dann keine Dokumentation von Programmteilen ausliefern will, die als solches nicht im Lieferumfang sind.

Ja, das geht tatsächlich. Man kann beliebige benutzerdefinierte Builds definieren (z.B. Demo, Light, Pro, Expert usw.) und bei Bedarf jedem Topic eine Kombination davon zuordnen. Beim Erzeugen des jeweiligen Ausgabeformats kann man dann die gewünschten Builds an- oder abwählen. Wenn z.B. ein Topic mit Pro und Expert markiert ist, aber bei der Ausgabe nur Demo und Light aktiv sind, dann wird dieses Topic auch nicht ausgegeben.

Ich benutze das unter anderem für das oben erwähnte Branding meines Programms. Nicht alle Erscheinungsformen haben den vollen Funktionsumfang und das wird im Handbuch und der CHM entsprechend berücksichtigt.

[Uwe Raabe]

Zitat von mkinzler:

Es geht auch eher darum einfach mehrsprachige Dokus zu erzeugen.

In der Professional-Version ist das drin (natürlich nicht das Übersetzen selbst). Man erzeugt dazu für jede Sprache ein abhängiges Projekt und gibt das dann zum Übersetzen. Spätere Änderungen oder Ergänzungen lassen sich mit dem Project Synchronizer schnell auflisten. Der Übersetzer bekommt dann nur die Änderungen und die neuen Topics.

[freimatz]

Wo ich gerade arbeite auch Help + Manual, habe damit aber (fast) nichts zu tun.

Bei meinem eigenen Projekt erfasse ich in Word. Was danach kommt ist alles selbst entwickelt. Was ich brauche ist, dass sich die Anleitung selber anpasst auf die jeweils konfigurierten Module - und das kann m.W. kein Tool am Markt.

Aber wieso eigentlich überhaupt noch Handbuch? Geh mal in Windows 10 im den Exporer und drück F1.
Arbeitest du in so eine Branche wo man das noch braucht? Bei meiner vorigen Firma gabs nur noch Hilfe im Internet. Das wurde mit Confluence erstellt.

[bernau]

Nicht direkt die Antwort auf die Frage, aber vielleicht trotzdem hilfreich.

Wir sind mittlerweile komplett auf WIKI umgestiegen und verwenden Dokuwiki

Alle Anwender sind dann immer auf dem neusten Stand. Mit Plugin können mehrere Sprachen verwendet werden.

Die Hilfebuttons im Programm rufen dann nicht die Hilfedatei auf, sondern die entsprechende Internetseite.

Ist dann nicht lokal. Also Internet zwingend erforderlich. Aber einen Tod muss man immer sterben.