Dokumentationsformate


Durch ein Hilfe-Entwicklungstool erstellte Dokumentationsformate.

Sollte ich meine Produktdokumentation mit Microsoft Word erstellen?

Should I use Microsoft Word to create my product's documentation ?

Microsoft Word ist eine tolle Software. Mit Microsoft Word können Benutzer mehr oder weniger alles schnell und einfach schreiben, von einem Schulbericht bis zu einem Geschäftsbrief. Der größte Vorteil von Microsoft Word ist der hohe Bekanntheitsgrad: Es ist eine Software, mit der die meisten von uns in der Schulzeit und im Büro aufgewachsen sind. Für viele Leute ist Microsoft Word noch immer die natürliche Wahl, wenn sie im Berufsleben etwas schreiben müssen. Und für die meisten Zwecke ist Microsoft Word ideal, es gibt jedoch einige Anwendungen, einschließlich des Schreibens von Produktdokumentationen, für die es nicht so gut geeignet ist.
Es gibt viele Gründe, warum Microsoft Word nicht das richtige Tool ist, um Ihnen beim Schreiben einer Produktdokumentation zu helfen; hier sind nur fünf dieser Gründe.

Mehr lesen →

Warum sollten Sie ePub- und Kindle-Versionen Ihrer Hilfedateien erstellen?

Kindle device

Jeder versteht die Wichtigkeit genauer und aktueller Hilfedokumentationen. Die Betriebsanleitung zu lesen und herauszufinden, wie man jede Funktion richtig anwendet, ist der einzige Weg, um das Beste aus einem Produkt herauszuholen. Die Schwierigkeit, vor der die Entwickler vieler Produkte stehen, ist die Formate auszuwählen, in denen die Hilfedokumentationen hergestellt werden sollen. Früher galt ein gedrucktes Handbuch für die meisten Produkte als ausreichend. Seit einigen Jahren wird das gedruckte Handbuch häufig durch entweder eine PDF- oder Online-Version ersetzt, sind diese jedoch die wirklich besten verfügbaren Optionen?

Mehr lesen →

Was ist ein Hilfe-Entwicklungstool?

images/what-is-a-help-authoring-tool.jpg

Das Verfassen von Hilfedokumentationen bedeutet harte Arbeit; ein technischer Redakteur muss jede Funktion eines Produkts auf verständliche Weise beschreiben. Die Dokumentation muss für eine große Bandbreite an Produktanwendern mit unterschiedlich ausgeprägter technischer Fachkenntnis oder verschiedenen Erwartungen geschrieben werden.
Trotz dieser Voraussetzung finden viele technische Redakteure, dass das Schreiben der Hilfedokumentation der einfache Teil des Prozesses ist. Nachdem sie alles aufgeschrieben haben, was notwendig ist, um das Thema ordentlich abzudecken, müssen sie die Dokumentation so formatieren, dass sie in einer Vielzahl an Formaten zugänglich und einfach lesbar ist. Eventuell erforderliche Formate umfassen PDF, Word, Online-HTML, vielleicht HLP oder auch CHM. Der ganze Formatierungsprozess kann sehr zeitaufwendig sein, vor allem da die meisten technischen Redakteure sich darauf konzentrieren wollen, wirklich gute Hilfedokumentationen zu schreiben, anstatt sich ewig darum zu kümmern, wie ihre Seiten auf verschiedenen Geräten angezeigt werden.
Wenn die Dokumentation schließlich fertig ist, bedeutet das häufig noch immer nicht das Ende des Prozesses, denn jedes Mal, wenn das Produkt abgeändert wird, muss die Dokumentation revidiert werden, um die neuen oder aktualisierten Funktionen widerzuspiegeln.

Mehr lesen →