Welche Software um ein Handbuch zu erstellen?

[hstreicher]

PDF ist imho nicht so das richtige, (jedenfalls nicht allein)
da es eine festes Seitenformat vorgibt und damit auf Geräten mit kleinen Bildschirmen zur Scrollorgie verkommt



mfg Hannes

[jobo]

Da nicht ganz genau klar ist, wo die Schwerpunkt liegen, aber vermutlich Flexibilität gewünscht ist, ein vielleicht unkonventioneller Vorschlag.
Markdown
mit "Anschlussmöglichkeiten" an alle gängigen Textformate,
Konvertierung vorwärts / rückwärts nach Doc, Docx, OpenDocument und
letztlich oder direkt pdf via pandoc o.ä.

Die Konvertierungstools haben zwar ihre Grenzen und wirken im Detail etwas chaotisch (was auch am Zielformat .doc liegen mag). Aber man hat dennoch ein Quellformat, aus dem sich (fast) alles machen lässt.
Durch die Anreicherung reiner Textdateien kann man sicher gut skripten und sich u.U. auch workflows bauen, mit denen bspw. Screenshots halbwegs komfortabel angepasst werden können.
Die Tools (Bildverarbeitung) siedeln aber eher im Linuxumfeld an, zumindest stammen sie eher von dort.
Meine Anfänge damit haben noch nicht zu öffentlichen Handbüchern geführt und sind momentan pausiert, aber es geht für mich stark in die Richtung Trennung von Daten(haltung/Verarbeitung) und Visualisierung, wie es so gern beim Coding proklamiert wird.

Ist natürlich nicht gerade eine out of the box Lösung. Aber mit Docker o.ä. kommt man recht schnell zu Ergebnissen.

[bcvs]

Wieso meinst du, dass die Webseite nicht up to date ist. Der letzte Blog-Eintrag unter "Company" ist jedenfalls vom 26.03.2018.

Ich nutze Help&Manual, weil man damit verschiedene Formate aus einer einzigen Quelle erzeugen kann. CHM für kontextsensitive Hilfe und PDF für die Ausdruck-Freaks unter den Usern.

[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.

[rapante]

Wir sind gerade dabei auf helpndoc umzusteigen.

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

[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.

[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 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.

[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.