Der Umgang mit Medien erlebt im Moment einen geradezu dramatischen Umbruch. Kaum jemand nimmt noch ein Buch zur Hand, dagegen ist das Smartphone zur universellen Informationsquelle geworden, mit dem jeglicher Informationsbedarf leicht und schnell gedeckt werden kann.
Auch Technische Dokumentation muss diesem Trend folgen und elektronisch und mobil leicht verfügbar werden. Dazu müssen wir Technischen Redakteure das, was wir bisher professionell auf Papier publiziert haben, zukünftig auf Tablet und Smartphone bringen.
Dieses Buch möchte vor allem unsere redaktionellen Fähigkeiten updaten:
Dieses Buch ist im Prinzip so geschrieben, dass Sie es von vorne bis hinten lesen können. Aber wer tut das schon? Fachbücher werden meistens quergelesen, entsprechend dem Vorwissen und der individuellen Fragestellung.
Auch in diesem Buch können Sie stöbern, querlesen, sich inspirieren lassen… Schön wäre es aber, wenn Sie nach und nach das ganze Buch lesen.
Dieses Buch ist (erstmal) text- und papierorientiert aufgebaut und publiziert, wobei ich mich bemühe, das redaktionelle Wissen zu systematisieren.
Praktische Beispiele zu Einzelaspekten finden Sie als Link bei den entsprechenden Textstellen.
Alle Beispiele stehen auf der Internetseite:
Sie können die Beispiele gut auf dem Tablet oder Smartphone ansehen.
Der Aufruf über Codes ist dabei besonders praktisch, da Sie keine langen Internetadressen eintippen müssen.
Wenn Sie Fragen oder Anregungen haben, können Sie gerne mit dem Autor in Kontakt treten.
Dietrich Juhl
www.juhl.de
dietrich@juhl.de
Folgende Firmen haben meine Arbeit unterstützt.
Vielen Dank dafür!
1 Wir (TRs) können Papier
Texte, Bilder, Strukturen… durchdacht, optimiert…
2 elektronische Dokumentation ist erst mal textbasiert
alles ist (erst mal) so, wie wir es bisher auf Papier gemacht haben
3 Was ist elektronisch (erst mal) anders?
Zugriff über kleinen Bildschirm
Inhalt auf kleinem Bildschirm
Tabellen und Bilder dürfen nicht zu groß sein
Volltextsuche ist möglich
andere Bedienung (der Doku)
4 Ansprüche werden größer
gewünscht wird ein direkter Zugang zur Info (gezielte Frage, gezielte Antwort)
möglichst wenig Antwort (zur gezielten Frage)
leicht verständliche Antworten (z.B. Video wird bevorzugt)
offen für neue Erfahrungen (z.B. Augmented Reality)
5 Was kann besser werden durch elektronisch?
andere Text-Darstellungstechniken (Aufklapptexte, Popups…)
andere Zugänge zum Inhalt
multimediale Darstellung einzelner Informationseinheiten
neue Benutzeroberfläche (auch Sprachsteuerung, Sprachausgabe…)
Einbindung der Tablet / Smartphone Hardware (Kamera, Bluetooth, macID…)
6 Was kann die Zukunft bringen?
Ganz andere Ordnungen (unserer Inhalte)
Ganz andere Zugänge (Navigation)
Ganz andere Darstellungen (der Inhalte)
Unter elektronischer Dokumentation möchte ich hier jede Technische Dokumentation verstehen, die elektronisch gespeichert und über entsprechende elektronische Ansichtsgeräte dargeboten wird.
Im Moment wird es vor allem um die ersten beiden Ausprägungen gehen.
Noch vor der Dokumentation steht die (gute) Bedienoberfläche des zu beschreibenden Gerätes, die durch Gestaltung teilweise schon zur richtigen Bedienung führt.
Die in die Bedienoberfläche integrierte Anleitung in Form von ausführlichen Erläuterungen, Tooltipps, integrierter Hilfe (z.B. Popups) oder als geführter Vorgang (z.B. Wizzard) würde ich zur Technischen Dokumentation rechnen, aber nicht hier bei der elektronischen Dokumentation betrachten wollen.
M.E. ist es in den meisten Fällen besser, die Informationen bereits ins Produkt zu integrieren (z.B. Popups, Wizzards), als sie in einem zweiten Medium (Papier oder elektronisch), das erst zugeordnet werden muss, anzubieten.
Elektronische Dokumentation kann über diverse Ansichtsgeräte dargestellt werden.
Bekannt sind zum Beispiel im Moment:
Formate, in denen elektronische Dokumentation gespeichert wird sind vor allem:
| PDF als die elektronische Form von Papierseiten | |
| CHM | Compiled HTML Help, wie es in Windows Onlinehilfen benutzt wird |
| ePub | ePub, als ein Standardformat für eBooks |
| HTML 5 | HTML 5 ist das Standardformat, wie es vor allem im Web benutzt wird. In diesem Format können sehr viele Darstellungsformen realisiert und auch multimediale Inhalte eingebunden werden. |
| Apps | Häufig werden auch eigene Apps angeboten, die dann eine oder mehrere Dokumentationen enthalten. |
Je nach Anwendungsfall, kann die Dokumentation auf einem der folgenden Medien erfolgen (nach tekom, intelligent information initiative 2015):
Elektronische Dokumentation kann online oder offline bereitgestellt werden.
Die Dokumentation ist bereits lokal gespeichert und kann vom Ansichtsgerät direkt angezeigt werden.
Die Dokumentation liegt irgendwo auf dem Server und wird im Moment der Benutzung von dort geladen. Das hat Vor- und Nachteile.
Bei einer Online-Verbindung können zusätzliche Features benutzt werden:
Vorneweg möchte ich Ihnen hier ein paar Beispiele zeigen, um die elektronische Dokumentation jetzt schon „anfassbar“ zu machen.
Bitte beachten Sie, dass ich mich in diesem Buch vielfach auf die von mir geschaffenen 5 Inhaltskategorien aus meinem Buch beziehe.
Dietrich Juhl, Technische Dokumentation:
Praktische Anleitungen und Beispiele, 3. Auflage, Springer-Verlag 2015
Siehe auch: Code juhl1
Im o.g. Buch beschreibe ich, dass für Anleitungen fünf Inhalte wichtig sind und unterschieden werden sollen.
Sie wird meist als Handlungsanweisung ausgeführt, kann aber auch anders sein (z.B. Abbildung des Handlungsergebnisses, Bediensystematik…)
Normalerweise schreiben und gestalten wir eine Gesamtdokumentation mit allen wichtigen Informationen zum Produkt.
Solche Anleitungen sind häufig hundert oder mehrere hundert Seiten lang.
Die Informationen sind in einem Kapitelsystem hierarchisch angeordnet,
Eine solche Gesamtdoku mobil zu machen ist das Eine.
Zum anderen möchten wir vielleicht nur einen Einzelaspekt als separates Dokument elektronisch anbieten, z.B.:
Solche Einzelanleitungen können durchaus sinnvoll sein. Sie müssen aber findbar (URL, QR…) und / oder in ein Gesamtdokusystem eingebunden sein.
Schon seit Langem ist es üblich, Technische Dokumentation für den PC zu liefern.
(Die könnte sich der Anwender ausdrucken, wenn er eine gedruckte Version bevorzugt. Die Erfahrung zeigt, dass Anwender das früher getan haben, der Trend aber eindeutig zurückgeht).
Eine PDF-Version wird meist mitgeliefert, wobei diese häufig ein Unterverzeichnis mit einer Menge Zulieferer-Dokumentation enthält.
z.B. Smartphones, Drucker, Kameras, Fotoapparate.
Wenn es für den Einsatz der Dokumentation wichtig ist, jederzeit und auch mobil auf Informationen zugreifen zu können, ist es sinnvoll, die Doku in einem Tablet-tauglichen Format anzubieten, z.B.:
Gebräuchlich sind im Moment immer noch PDFs (ggf. in einer Tablet-optimierten Form) vielfach aber auch HTML oder proprietäre Apps.
Die Gesamtdoku auf einem Smartphone kann m.E. nur sinnvoll sein, wenn die Information immer, zum Beispiel auch im Notfall, verfügbar sein muss.
In diesem Fall nimmt der Anwender auch eine unkomfortable Navigation und die Darstellung auf dem kleinen Bildschirm in Kauf.
Vielleicht besteht aber auch der Bedarf (beim Anwender), eine Anleitung in Mußezeiten zu lesen, z.B. beim Warten. Der Anspruch ginge dann vielleicht mehr in Richtung „stöbern“, sich inspirieren lassen.
Tatsächlich gibt es Anleitungen auf dem Smartphone, z.B.
Inwieweit das Navigieren, Suchen und Lesen ein Vergnügen ist, möchte ich dahingestellt lassen.
iphone