Entwicklung eines dynamischen, interaktiven Manuals mit Hilfe eines Content-Management-Systems

Die Systemlandschaft der Pirobase Imperia AG


Bachelorarbeit, 2017

77 Seiten, Note: 2,7


Leseprobe

Inhaltsverzeichnis

1. Einleitung

2. Manual
2.1 Autor
2.2 Sicherheit zu erst
2.3 Aufbau eines Manuals
2.4 Gedruckte Form
2.5 Allgemeine Konstruktionsregeln
2.5.1 Getrennt vom Gerät
2.5.2 Auf dem Gerät
2.6 Aufmachung des Manuals
2.7 DIN EN 82079-1
2.8 Erstellungstools
2.8.1 Microsoft Word & Open Office Writer
2.8.2 FrameMaker
2.8.3 Help+Manual
2.9 Schreibeprozess
2.9.1 Planungsphase
2.9.2 Formulierungsphase
2.9.3 Änderungsphase
2.10 DIN EN 82079-1 Redaktionsprozess

3. Social Web
3.1 Social Software
3.2 Kollektive Intelligenz
3.3 Social Collaboration
3.4 Forum
3.5 Gefahr der Foren
3.6 Social Costumor Relationship Management
3.7 Social CRM in der Forenpraxis

4. Content Management System
4.1 Frontend & Backend
4.2 Funktionsweise CMS
4.3 Assets
4.4 Content-Life-Cycle
4.5 Design
4.6 Zielgruppen
4.7 CMS im Manual Prozess

5. EPUB3
5.1 EPUB3 Format
5.2 EPUB3 Multimedia
5.3 EPUB3 Styling
5.4 EPUB3 Scripting
5.4.1 Progressive Enhancement
5.4.2 Content erweitern
5.4.3 Content generieren
5.4.4 Content analysieren und kalkulieren
5.4.5 Content entfernen
5.5 Scripted Remote Interactivity
5.5.1 HTML Form
5.5.2 iFrame
5.6 Metadaten

6. CMS zu EPUB3
6.1 Konvertierungspipeline Daisy
6.2 HTML Export aus dem CMS
6.3 Struktur und Inhaltsverzeichnis
6.4 Daisy EPUB3 Metadaten

7. @boox
7.1 @boox IST
7.2 @boox SOLL
7.3 Identify matching Manual
7.4 @boox nach DIN EN 82079-1
7.5 Schnittstelle CMS - @boox
7.6 Interaktion
7.6.1 @boox & Progessive Enhancement
7.6.2 @boox & Scripted Remote Interactivity
7.6.3 Forum
7.6.4 Zukünftige Interaktionsmöglichkeiten

8. Dynamisches und Interaktives Manual
8.1 Erster Schritt
8.1.1 Planungsphase
8.1.2 Formulierungsphase
8.1.3 Änderungsphase
8.1.4 Qualitätskontrolle
8.1.5 Veröffentlichung
8.2 Zusätzliche Schritte
8.2.1 Support
8.2.2 Analysephase
8.3 Prozessbeteiligte
8.3.1 Autor
8.3.2 Designer
8.3.3 Administrator
8.3.4 Scripter
8.3.5 Mediendesigner
8.3.6 Supporter
8.3.7 User
8.4 Anforderungen an die @boox App
8.5 Anforderung an das CMS

9. Fazit

Abbildungsverzeichnis

Abbildung 1: DIN EN 82079-1

Abbildung 2: Schreibeprozess basierend auf dem Modell von Hayes und Flower

Abbildung 3: DIN EN 82079-1 Redaktionsprozess

Abbildung 4: Ebersbachs Dreiecksmodell

Abbildung 5: CMS Backend & Frontend Zugriff

Abbildung 6: Phasen des Content-Life-Cycle

Abbildung 7: Inhalt für gemeinsame Zielgruppen

Abbildung 8: Website des High School Sports in Mississippi 2015

Abbildung 9: Website des High School Sports in Mississippi 2017

Abbildung 10: Beispielhafte Umsetzung des Javascript Code in einem EPUB3 Reader

Abbildung 11: Beispielhafte Umsetzung des Javascript Codes mit Hilfe eines Buttons in einem EPUB3 Reader

Abbildung 12: Beispielhafte Umsetzung des Javascript Codes für Binomische Formeln in einem EPUB3 Reader

Abbildung 13: Scripted Remote Interactivity zwischen HTML Form im EPUB3 und einem Webserver

Abbildung 14: iFrame Einbindung in einem EPUB3

Abbildung 15: Aktuelle IT-Infrastruktur der @boox App

Abbildung 16: Workflow der ersten Nutzung der @boox App

Abbildung 17: SOLL Workflow

Abbildung 18: SOLL IT-Infrastruktur für die Verwendung für Manuals

Abbildung 19: Beispielhafte IT-Infrastruktur für die Verknüpfung von CMS und @boox App

Abbildung 20: Aktuelles Design des Forums

Abbildung 21: Mock-Ups für die Verwendung des Forums im Umgang mit Manuals

Abbildung 22: Beispielhaftes ER-Diagramm für die Datenspeicherung des Forums

Abbildung 23: Erweiterter Schreibeprozess basierend auf dem Modell von Hayes und Flower

Abbildung 24: Abbildung 24: Erweiterter Redaktionsprozess nach DIN EN 82079-1

Abbildung 25: Delegation der Support Level

Abbildung 26: Ablauf des Supportprozess

Abbildung 27: Rollen und deren Zugriffspunkt im Gesamtkonzept

Tabellenverzeichnis

Tabelle 1: Microsoft Word & Open Office Writer Vor- und Nachteile

Tabelle 2: FrameMaker Vor- und Nachteile

Tabelle 3: Help+Manual Vor- und Nachteile

1. Einleitung

§ 4 Absatz 2 des Geräte- und Produktsicherheitsgesetzes (GPSG) besagt:

"Ein Produkt darf, soweit es nicht § 4 Abs. 1 unterliegt, nur in den Verkehr gebracht werden, wenn es so beschaffen ist, dass bei bestimmungsgemäßer Verwendung oder vorhersehbarer Fehlanwendung Sicherheit und Gesundheit von Verwendern oder Dritten nicht gefährdet werden. Bei der Beurteilung, ob ein Produkt der Anforderung nach Satz 1 entspricht, sind insbesondere zu berücksichtigen:

Abbildung in dieser Leseprobe nicht enthalten[1]

Danach gilt für alle Produkte bei denen während der Installation, Verwendung, Instandhaltung und Erweiterung eine Gefahr für die Gesundheit und Sicherheit des Verbrauchers besteht, dass diese mit einer beigelegten deutschsprachigen Bedienungsanleitung versehen werden müssen. Diese Bedienungsanleitungen sollen dem Verbraucher den Nutzen des gekauften Produktes erläutern. 2015 wurde erstmals festgelegt, dass diese Bedienungsanleitungen auch in elektronischer Form den Anforderungen des Produktsicherheitsgesetzes genügen müssen.[2]

Der Wandel des Webs zu einer Ebene, auf der jeder Nutzer seinen eigenen Inhalt erstellen und verwalten konnte, sorgte auch für einen Wandel im Erfassen und Teilen von Informationen über das Web. Längst waren Bedienungsanleitungen nicht mehr die einzige Informationsquelle zu einem gekauften Produkt. Das Wissen um eine Marke, ein Unternehmen oder ein Produkt wurde schnell über die mit den Web 2.0 aufgekommenen neuen Plattformen verteilt, diskutiert und analysiert.

Währenddessen blieb die Definition einer Bedienungsanleitung stets die selbe:

"Bei einer Bedienungsanleitung (oder: Gebrauchsanleitung, Manual) handelt es sich um eine schriftliche Anleitung zur sicheren Verwendung eines Gerätes."[3]

Das allgemeine Verständnis einer Bedienungsanleitung liegt auf einem gedruckten Dokument, welches rein zum Konsumieren vorgesehen ist. Doch mit Hilfe neuer Technologien und neuer Systeme liegt es nahe eine Bedienungsanleitung zu erzeugen, welche nicht nur rein statisch zum Konsumieren gedacht ist, sondern viel mehr als interaktives Medium betrachtet werden kann, bei dem der Nutzer mit der Bedienungsanleitung interagieren kann. Verknüpft man diese noch mit den Prinzipien, welche das World Wide Web bietet, eröffnet man sowohl für den Nutzer als auch für Unternehmen eine neue Art der direkten Kommunikation untereinander.

Um ein solches interaktives Manual zu erzeugen, gilt es im Vorfeld allerdings festzustellen, welche aktuellen Technologien und Systeme in diesem Erstellungsprozess vorzusehen sind. Der Fokus hierbei liegt auf dem Content Management System und der @boox Android und iOSApp, entwickelt von Studenten der Hochschule Bonn-Rhein-Sieg unter der Führung von Prof. Dr. Thorsten Bonne.[4] Außerdem gilt es zu identifizieren, wer an der Erstellung dieses Dokuments in welcher Art beteiligt ist.

Auch fest zu halten ist die Art wie ein Nutzer mit dem Manual interagieren kann und welcher Mehrwert dadurch für den Nutzer, den Ersteller des Manuals und das Unternehmen, welches das Produkt hergestellt hat, erzeugt werden kann.

2. Manual

Ein Manual stellt eine Sammlung von Informationen zum Umgang mit einem Produkt dar. Der Umfang eines Manuals kann dabei je nach Produkt stark variieren. Nicht immer gilt ein ausführliches Manual als zwingend notwendig, vor allem bei einfachen Geräten, die durch leicht verständliche Bedienanforderungen verwendet werden können. Im Gegensatz dazu stehen Geräte, welche nicht durch reines Ausprobieren zum gewünschten Ergebnis führen, deren Bedienabläufe also als komplex anzusehen sind. Solche benötigen eine ausführliche Beschreibung der Abläufe.

Je nach Produkt gilt es festzuhalten:

- Allgemeine Funktionalität des Produktes
- Identifikation des Produktes
- Sicherheitsinformationen
- Gebrauch des Produktes
- Instandhaltung
- Informationen über Zubehör und Ersatzteile
- Informationen zu speziellen Werkzeugen und Geräten
- Reparatur und Austausch von Teilen[5]

2.1 Autor

Abhängig vom Umfang sind auch der Aufwand und die damit verbundenen Kosten bei der Erstellung. So kann bei einem einfach gehaltenen Manual mit einem Umfang von ca. 30 Seiten mit einer Dauer von ca. 20 Tagen gerechnet werden.[6]

Entscheidend ist auch, von wem dieses Manual angefertigt wird, denn grundsätzlich bleibt einem Unternehmen dabei die Wahl zwischen:

1. Der internen Lösung, bei welcher der Mitarbeiter zwar das notwendige Wissen um das Produkt besitzt, möglicherweise aber nicht die Fähigkeit, dieses Wissen in einfacher Form wieder zu geben.
2. Der externen Dienstleistung, welche zwar Qualität bei der Erstellung des Manuals aufweist, allerdings kein detailliertes Wissen über das Produkt besitzt.
3. Dem externen Freiberufler, welcher weder Qualität gewährleistet noch detailliertes Wissen besitzt, dafür allerdings eine kostengünstige Alternative darstellt.[7]

Eine mögliches Auswahlkriterium für den richtigen Autor stellt die Art des Produktes dar, und damit verbunden die Wichtigkeit des Manuals für den Nutzer.

Bei Geräten, deren Bedienung einfach verständlich und leicht zu merken ist, ist der Bedarf eines professionell erstellten Manuals sehr viel geringer als bei einem Gerät, welches komplexe Abläufe für die ordnungsgemäße Anwendung vorraussetzt.

Natürlich kann ein Manual auch von mehr als einer Person geschrieben werden. Damit der gesamte weitere Ablauf aber leicht verständlich und übersichtlich bleibt, wird davon ausgegegangen, dass diese Autoren, sofern mehrere an der Erstellung beteiligt sind, einen einzelnen Autor repräsentieren.

2.2 Sicherheit zu erst

Um eine einwandfreie Betriebsanleitung zu gewährleisten, sollten Hersteller und Autor also Hand in Hand arbeiten. Es gilt das Prinzip Sicherheit hat immer Vorrang und besagt, dass der Nutzer erwartet, dass das erworbene Produkt hält, was es verspricht. Außerdem sollte er sich zu Recht darauf verlassen können, dass das Produkt bei korrekter und bestimmungsgemäßer Bedienung keinen Schaden verursachen kann oder nimmt.[8]

Daher ist jeder Hersteller verpflichtet in Abstimmung mit dem Autor Warn- und Sicherheitshinweise präzise im Manual unterzubringen. Dem Benutzer müssen sämtliche Informationen über die korrekten Verhaltensmaßnahmen genauestens beschrieben werden. Risiken, die durch das Produkt entstehen, werden mit Hilfe von Schutzmaßnahmen verringert oder eliminiert. Bestehen weitere Restrisiken, müssen diese dem Benutzer deutlich vermittelt werden.[9]

2.3 Aufbau eines Manuals

Eine konkrete Vorlage für den Aufbau eines Manuals lässt sich grundsätzlich nicht festlegen, da dieses produktabhängig ist. Ein Vorschlag für den Aufbau:

1. Titel

- Die Bennennung der Betriebsanleitung mit Produktbezeichnung

- Ein Bild des Produktes
- Name und Logo des Herstellers
- Anschrift des Herstellers
- Identifikation durch Serien-, Typ-, Modell-, Erzeugnis-, Bestell-, Artikelnummer

2. Erklärung

- Absicht des Dokuments
- Zielgruppe
- Inhaltsverzeichnis
- Index
- Glossar
- Bilderverzeichnis

3. Warnhinweise

- Sicherheitshinweise
- Aufzählung sämtlicher Restrisiken, auch bei korrekter Bedienung
- Hinweis auf Verbot von Veränderung oder Umbauten
- Erklärung von Warnhinweisen und Symbolen

4. Produktbeschreibung

- Abbildung des Produktes mit Erklärung der Bedienungselemente
- Verwendungszweck
- Produktkennzeichnung

5. Erste Benutzung

- Anwendungshinweise für oder vor der ersten Benutzung
- Mögliche Installation oder Aufbau des Produktes
- Erste Inbetriebnahme des Gerätes

6. Bedienung und Anwendung

- Bildliche Darstellung der Benutzung des Produktes
- Beschreibung von Bedienungsabläufen
- Beschreibung der Funktionen des Produktes

7. Reparatur und Wartung

- Erklärung der Notwendigkeit regelmäßiger Wartung
- Beschreibung der notwendigen Schritte für eine sachgemäße Wartung
- Erklärung von Warnsignalen
- Erklärung von Störungsanzeigen
- Hinweise zur Behebung von Fehlfunktionen und Störungsanzeigen

8. Technische Daten

- Gewichte und Maße
- Energieversorgung und Energieverbrauch
- Anschlüsse und Schnittstellen

9. Entsorgung

- Beschreibung der Demontage
- Angabe von Sicherheits- und Warnhinweisen
- Hinweis auf gesetzlich vorgeschriebene Entsorgungsmaßnahmen und Entsorgungsstellen[10]

2.4 Gedruckte Form

Das Manual muss nicht alle zuvor genannten Kriterien vollständig erfüllen. Zu beachten ist allerdings, dass es für jede Zielgruppe die nötigen Informationen liefert. Klassisch ist dabei die Papierform, welche praktischerweise handlich nutzbar sein sollte. Das Taschenbuchformat bietet sich dabei besonders an, da schnell ein Ablageort gefunden ist und außerdem immer griffbereit liegt. Kostenaspekte bestimmen dabei die Wahl des Papiers, allerdings sollte es eine hohe Haltbarkeit aufweisen.

Mittlerweile werden Manuals neben der Papierform auch auf elektronischem Weg für Smartphones und Tablets angeboten, allerdings müssen alle die Sicherheit betreffenden Informationen zusätzlich in gedruckter Form vorliegen, damit sie zu jedem Zeitpunkt einsehbar sind.[11]

2.5 Allgemeine Konstruktionsregeln

Generell gilt es auch zu beachten, wo das entsprechende Manual hinterlegt ist. Ob dies getrennt vom Gerät oder auf dem Gerät selbst vorzufinden ist. Entsprechend sind Kriterien bei der Erstellung zu beachten, bezüglich der Lesbarkeit, Beschaffenheit, Verständlichkeit, Übersichtlichkeit, Vollständigkeit, Problemvorsorge.[12]

2.5.1 Getrennt vom Gerät

Vom Gerät getrennte Manuals besitzen neben den für den Betrieb notwendigen Daten weitere Informationen, wie z.B. technische Daten. Diese Manuals können umfangreich werden, und es besteht die Gefahr, dass bei älteren Geräten das Manual nicht mehr auffindbar ist, wie:

- Schnelle und sichere visuelle Erfassung von Text und Abbildungen ermöglichen

Voraussetzung für die fehlerfreie Aufnahme der Informationen ist es, sicher zu stellen, dass eine sinnvolle Gestaltung von Schriftzeichen und graphischen Elementen gegeben ist.

- Handhabung des Manuals

Neben der Anforderung für das Lesen und Verstehen eines Manuals gilt auch entscheidend, wie die rein körperlichen Anforderungen gegenüber dem Benutzer aussehen. Faktoren wie Papierqualität, Bindeart, Größe beeinflussen dabei das Verhalten des Nutzers im Umgang mit dem Manual.

- Umgang mit neuen Informationen, sowie die Umsetzung der Anweisungen in die praktische Ausführung vereinfachen.

Der Nutzer sollte immer nur mit einer überschaubaren Menge von Informationen konfrontiert werden, welche so verständlich vermittelt werden, dass der Benutzer eine korrekte Umsetzung am Gerät durchführen kann.

- Anwendung der Anweisung auf das Gerät erleichtern

Das Hin- und Herblicken zwischen Gerät und Text ist bei komplexem Ablauf fast unvermeidlich, daher sollte es dem Nutzer leicht gemacht werden, die entsprechende Textstelle schnell wieder zu finden.[13]

2.5.2 Auf dem Gerät

- Schnelle und sichere visuelle Erfassung von Text und Abbildungen ermöglichen

Genau wie bei Manuals getrennt vom Gerät.

- Behinderung durch den Gebrauch des Manuals vermeiden

Das am Gerät angebrachte Manual darf den Benutzer nicht dabei behindern, das Gerät zu benutzen während er Gebrauch vom Manual macht.

- Umgang mit neuen Informationen, sowie die Umsetzung der Anweisungen in die praktische Ausführung vereinfachen

Genau wie bei Manuals getrennt vom Gerät.

- Gedächtnishilfe anbieten

Das Manual soll fehlende Informationen für umfangreiche Bedienvorgänge bereitstellen, an die sich der Benutzer nicht oder nicht vollständig erinnern kann.

- Anwendung der Anweisung auf das Gerät erleichtern

Bei einem Schwenken des Blickes vom Gerät zur Bedienungsanleitung sollte die benötigte Information schnell im Blickfeld sein, da sonst Bedienabläufe zu lange unterbrochen werden müssen.[14]

Auf dem Gerät vermerkte Bedienanweisungen sind bei Geräten empfehlenswert, deren Bedienung verständlich und leicht zu merken sind. Dieses kann sowohl durch einen einfachen Bedienungsablauf, als auch über regelmäßige Bedienung geschehen.

2.6 Aufmachung des Manuals

Die Aufmachung eines Manuals ist jedem Hersteller selbst überlassen. Zu empfehlen ist allerdings die Unterteilung in Abschnitte und Kapitel, da sich hierdurch eine größere Übersichtlichkeit ergibt.

Grundsätzlich animiert eine gut strukturierte Betriebsanleitung den Benutzer eher, sie zu gebrauchen. Außerdem kann es das Image des Herstellers positiv beeinflussen.[15]

Neben der Struktur erlauben weitere einfache Formatierungen eine höhere Übersichtlichkeit. Darunter fallen unter anderem Tabellen, Nummerierungen und Farben. Wie schon festgestellt, ist eine deutlich lesbare Schriftart und Schriftgröße Grundvoraussetzung. Kurze und prägnante Sätze erleichtern die Verständlichkeit, außerdem empfiehlt es sich Fachausdrücke, Symbole und Abkürzungen bei ihrer ersten Erwähnung mit einer Erklärung zu versehen und diese in einem Glossar zu hinterlegen. Eventuell aufkommende Fragen sollten von vornherein behandelt und beantwortet werden.

Zusätzlich lässt sich Corporate Design (gesamtes, einheitliches Erscheinungsbild) auf das Manual anwenden, um somit das visuelle Erscheinungsbild seines Unternehmens und seine Qualität zu präsentieren.[16]

Exakte Zeichnungen und Bilder sorgen für weitere Verständlichkeit und bieten dem Autor die Möglichkeit, den Text so kurz wie nötig zu halten. Diese sollten nummeriert sein, damit sie mit Hilfe von Querverweisen leicht zu finden sind. Strichzeichnungen bieten eine hervorragende Darstellungsmöglichkeit, da sie sich auf das wesentliche reduzieren lassen, und es einfach machen, bestimmte Elemente wie Schalter oder Anzeigeelemente zu betonen.

Die Verknüpfung von Text und Bild stellt eine sinnvolle Kombination dar, um das Manual logisch und verständlich zu gestalten. Deshalb ist darauf zu achten, dass die Zugehörigkeit zwischen Bild und erklärendem Text eindeutig erkennbar ist.[17]

Auch mit Hilfe von Piktogrammen (Icons) können Umstände, Begebenheiten und Vorgänge grafisch vereinfacht erklärt werden. Besonders für die Beschreibung von Sicherheits- und Warnhinweisen werden diese häufig eingesetzt.[18]

Wird ein Produkt in mehreren Ländern vertrieben, muss das Manual mit der gleichen Sorgfalt in die entsprechenden Sprachen übersetzt werden. Die notwendige Übersetzung sollte stets von Fachübersetzern vorgenommen werden, welche Erfahrung auf dem jeweiligen Gebiet besitzen.

2.7 DIN EN 82079-1

Die Erstellung von Anleitungen, Gliederung, Inhalt und Darstellung wird seit September 2012 durch die Europäische Norm EN 82079-1 geregelt. Die Norm richtet sich nicht nur an die technischen Redakteure des Herstellers, sondern auch an Illustratoren, Softwareentwickler, Übersetzer, Dokumentations- und Qualitätsbeauftragte, Gutachter, Aufsichtsbehörden u.a.

Die Norm stellt dabei mehr dar als nur eine Vorlage für ein Manual, sondern soll auch dafür sorgen, dass eine aktuelle, korrekte und rechtskonforme Instruktion zu einem Produkt erstellt wird. Da der Hersteller bei entstandenem Schaden, welcher mangelhaft, unvollständig oder missverständlich durch das Manual mitverschuldet wird, haftbar gemacht werden kann. Die DIN EN 82079-1 bietet allen Parteien, die mit dem Erstellen von Manuals zu tun haben, Ansätze von Risiken zu mindern.[19]

Die Abb. 1 zeigt die wichtigsten Prinzipien der Norm.

Abbildung in dieser Leseprobe nicht enthalten

Abbildung 1: DIN EN 82079-1

Quelle: http://www.maschinenrichtlinie-2006-42-eg.de/erstellen-von-anleitungen-das-sollten-sie-%C3%BCber-die-neue-din-en-82079-1-wissen, 22.08.2017

2.8 Erstellungstools

Die Anzahl an Tools zur Erstellung eines Manuals ist groß, da im Grunde jedes Textverarbeitungsprogramm zu diesem Zweck genutzt werden kann.

Zum Vergleich werden im Folgenden einige der Tools vorgestellt und miteinander verglichen.

2.8.1 Microsoft Word & Open Office Writer

Microsoft Word & Open Office Writer stellen die beiden bekanntesten Textverarbeitungsprogramme dar. Man kann davon ausgehen, dass jeder Nutzer eines Rechners mindestens eines der beiden Programme verwendet. Beide Programme sind sehr ähnlich, unterscheiden sich nur minimal in ihrer Funktionsweise und dem Preis. Während Open Office eine freies Office Paket ist, ist Microsoft Word nur kostenpflichtig erhältlich. Diese Programme dienen rein zur Texterstellung und erlauben es Elemente wie Abbildungen, Grafiken und Tabellen beliebig im Dokument anzuordnen.[20]

Abbildung in dieser Leseprobe nicht enthalten

Tabelle 1: Microsoft Word & Open Office Writer Vor- und Nachteile

2.8.2 FrameMaker

FrameMaker ist ein professionelles Autorenwerkzeug der Adobe Systems und dient zur Erstellung und Verwaltung von technischen Inhalten für Mobilgeräte, Web, Desktop und Print. FrameMaker ist ein Programm zur Erstellung und Bearbeitung komplexer und hochwertig gelayouteter Dokumente. Verzeichnisse wie Inhaltsverzeichnis, Index, u.v.m. werden semiautomatisch generiert.[21]

Abbildung in dieser Leseprobe nicht enthalten

Tabelle 2: FrameMaker Vor- und Nachteile

2.8.3 Help+Manual

Help+Manual ist ein Autorenwerkzeug, das es erlaubt ein Dokument zu erstellen, welches über verschiedene Outputformate verteilt werden kann. Diese Dokumente können von mehr als einem Autor zeitgleich bearbeiten werden und vom Prinzip her wie Source Code Repositorys synchronisiert.[22]

Abbildung in dieser Leseprobe nicht enthalten

Tabelle 3: Help+Manual Vor- und Nachteile

2.9 Schreibeprozess

Der Prozess zum Schreiben eines Manuals durchläuft mehrere Phasen, die nach dem Modell von Hayes und Flower, wie folgt definiert sind: Planen, Formulieren und Überarbeiten. Diese Phasen werden in anderen Modellen, wie dem Modell von Kellogg, als Formulieren, Ausführen und Kontrollieren bezeichnet. Wichtig ist lediglich, dass neben der eigentlichen Phase, in der der Text geschrieben wird, weitere Phasen existieren, welche vor dieser Phase als Planungphase und nach dieser Phase als Überarbeitungsphase anzusehen sind. Dabei unterscheidet sich eine Phase immer abhängig von der Person und den Aufgaben, welche durchlaufen werden. Ehlich, Noack und Scheiter unterteilen die vorher genannten Phasen wiederum in Teilphasen. Auf die einzelnen Phasen und deren Teilphasen wird in den folgenden Kapiteln etwas genauer eingegangen.

2.9.1 Planungsphase

Die Planungsphase ist der erste Schritt im Erstellungsprozess und beschreibt die Aufgaben, die vor dem eigentlichen Schreiben stattfinden müssen. Der Planungsprozess besteht aus den Teilprozessen des Planen I und Planen II.

Im Planen I geht es mehr darum das eigentliche Textresultat zu entwerfen. Zu diesem Zweck:

- Eignet sich der Autor Wissen über den Sachverhalt an.
- Nach der Wissensaneignung beginnt die eigentliche Schreibeplanung.
- Das Wissen über das Produkt wird nach textartspezifischen Gesichtspunkten strukturiert. Hierzu gehört die Auswahl der notwendigen Informationen und die Linearisierung.

Das Ergebnis des Planen I soll ein grobes Textschema und damit verbunden eine grobe Gliederung des Textes darstellen.

Im Planen II geht es darum den Schreibprozess selbst zu konzipieren. Zu diesem Zweck:

- Plant der Autor die Tätigkeitsfolge, bei der die Reihenfolge der zu formulierenden Texte geplant wird.
- Die Zeitplanung, bei der der Autor plant wie lange er für einen Textabschnitt einplant und zu welchem Zeitpunkt er diesen Abschnitt schreibt.
- Technik und Organisation der Textherstellung müssen geplant werden.

Dieser Teilprozess kann optional auch entfallen.

Das Gesamtergebnis der Planungsphase stellt einen Textentwurf dar, welcher ein Textschema und ein Schreibkonzept enthält.[23]

2.9.2 Formulierungsphase

Die Formulierungsphase ist der zweite Schritt im Erstellungsprozess und dient dazu, das in der Planungsphase erstellte Textschema zu realisieren. Die Formulierungsphase besteht aus den Teilprozessen des Formulieren I und Formulieren II.

Im Formulieren I wird der Text erstmalig verfasst. Dabei muss der Entwurf in konkrete Formulierungen überführt werden, indem sprachliche Mittel ausgewählt und durchgehend linearisiert werden. Dazu müssen Entscheidungen über Begriffe und syntaktische Konstrukte getroffen werden, wie z.B. wird der Leser mit "Sie" oder "Der Benutzer" angesprochen.

In diesem Formulierungsprozess entsteht also die Feinstruktur des Textes.

Die Tätigkeit des Formulierens ist immer eng verbunden mit einem Leseprozess, bei dem ein regelmäßiger Wechsel zwischen Formulieren und Lesen stattfindet. Hierbei handelt es sich um ein sogenanntes begleitendes Lesen, welches den Formulierungsprozess ständig überwacht.

Nachdem der Autor die erste Textfassung erstellt hat, kann er sich entscheiden, ob er beim Formulieren I bleibt und einen weiteren Abschnitt formuliert, zum Formulieren II oder unmittelbar zur Änderungsphase übergeht.

Im Formulieren II werden in die bereits vorhandene Textstruktur weitere Textelemente eingefügt. So werden unter anderem im Formulieren I geplante Leerstellen ausgefüllt und entdeckte Lücken ergänzt. Der wesentliche Unterschied zum Formulieren I besteht darin, dass beim Formulieren II die Auswahl der sprachlichen Teilmuster und Mittel durch die bereits existierende Textstruktur begrenzt sind. Die Formulierung II orientiert sich an bereits fertigen Textteilen und hat damit direkte Auswirkung auf die zeitliche Planung des Erstellungsprozesses. Werden die verschiedenen Teile eines Textabschnittes zu verschiedenen Zeitpunkten geschrieben, steigt der zeitliche Bedarf je weiter die beiden Zeitpunkte auseinander liegen. Der Autor wird dabei nämlich gezwungen, die bereits fertige Textstruktur wieder zu erfassen, bevor er weiterformulieren kann.[24]

2.9.3 Änderungsphase

Die Änderungsphase stellt den dritten Schritt im Erstellungsprozess dar und besteht im Wesentlichen aus dem erfassenden Lesen und Korrigieren. Beim erfassenden Lesen werden die Formulierungen verglichen mit dem geplanten Textentwurf. Dazu zählt u.a. die Überprüfung, ob die im Text enthaltenen Darstellungen dem Sachverhalt entsprechen, ob alle Teilmuster des Entwurfs in der richtigen Reihenfolge realisiert wurden und das richtige Layout vorliegt.

Bei Fehlern, die während des erfassenden Lesen entdeckt werden, hat der Autor die Wahl, ob er diese sofort korrigieren oder notieren und zu einem späteren Zeitpunkt korrigieren möchte.[25]

Abbildung 2: Schreibeprozess basierend auf dem Modell von Hayes und Flower

Abbildung in dieser Leseprobe nicht enthalten

Quelle: Ehlich, Noack, Scheiter, 1994, S.28

2.10 DIN EN 82079-1 Redaktionsprozess

Abbildung 3: DIN EN 82079-1 Redaktionsprozess

Quelle: Schmeling, 2013, S. 50

Als informativen Anhang zur DIN EN 82079-1 wird ein Redaktionsprozess beschrieben, der den reinen Schreibprozess noch um die Punkte der Analyse, Qualitätssicherheit und Publikation erweitert. Die Analyse zielt dabei auf die Zielgruppenanalyse ab und kann als Teil der Wissensbeschaffung verstanden werden. Allerdings werden durch die Analyse auch die allgemeinen Bedingungen festgelegt, die das entsprechende Manual aufzuweisen hat. Als nächsten Schritt findet der vorher beschriebene Schreibeprozess statt. Das Ergebnis wird nach Abschluss des Schreibprozesses einer Qualitätskontrolle/Qualitätssicherung unterzogen. Diese Qualitätskontrolle findet anhand von empirischen Methoden und Nutzertests statt. Zu den empirischen Methoden zählen z.B.

- Befragungen
- Usability-Tests
- Selbsteinschätzungen und Checklisten
- Gutachten, Überprüfungen durch Experten und Zertifikate
- Rückmeldungen aus Beschwerdemanagement, Hotlines und Kundendienstinformationen[26]

Die Übersetzung ist ein optionaler Zwischenschritt bevor das Dokument produziert/veröffentlicht wird.

3. Social Web

Der Begriff Social Web umfasst die neuartigen Möglichkeiten, die das World Wide Web bietet, um Informationen auszutauschen, kollaborativ zu arbeiten, miteinander zu kommunizieren und Kontakte zu pflegen. Es gilt das Social Web als Innovationsprozess zu verstehen, welcher das Internet von einem reinen Abrufmedium zu einem Mitmach-Medium entwickelt. Der Begriff Social Web selbst umfasst dabei allerdings das Gesamtbild des Webs, welches auch die Rolle der Nutzer innerhalb des Webs beschreibt. Der Nutzer wird hier nicht mehr nur als reiner Konsument angesehen, sondern ist gleichzeitig Konsument&Produzent (Prosument).[27]

Abbildung in dieser Leseprobe nicht enthalten

Abbildung 4: Ebersbachs Dreiecksmodell

Quelle: Griesbaum, 2013, S. 564

Die Anwendungsgebiete des Social Webs lassen sich an Ebersbachs Dreiecksmodell veranschaulichen.[28]

Diese umfassen:

- Information: Publikation und Verteilung von Wissensobjekten
- Beziehungspflege: Aufbau und Aufrechterhaltung sozialer Kontakte
- Kollaboration: Kooperation und kollaborative Zusammenarbeit

Allerdings liegt in diesem Modell wie in Abb. 4 ein grundsätzliches Missverständis. Social Software Plattformen lassen sich so gut wie nie nur auf eine Ecke des Modells beschränken, stattdessen stehen sie mindestens zwischen zwei Ecken und können sogar zwischen allen drei Ecken stehen.

3.1 Social Software

Social Software ist Bestandteil des Web 2.0, dient zur Vernetzung von Menschen und die Organisation von Daten und Wissen sind wesentlich.[29]

Im Gesamtbild werden solche Anwendungen/Software/Plattformen, die darauf abzielen Anwender aktiv in ein soziales Netzwerk einzubeziehen als Social Software bezeichnet. Wobei der Begriff Social Software nicht eindeutig definiert ist, gilt:

Social Software beschreibt die für das Web typischen Tools, wie Webblogs, Foren, Wikis, Social Networking/Bookmarking-Dienste.

Einige typische Funktionen, die im Rahmen von Social Software zu finden sind:

- Das Erstellen und Teilen eines eigenen Profils
- Kontakt zu anderen Anwendern herstellen und halten
- Zusammenarbeit mit anderen Anwendern
- Informationen suchen, kommentieren, bewerten oder gar verändern
- Wissen und Informationen gemeinsam erarbeiten, darstellen oder austauschen

3.2 Kollektive Intelligenz

Wissen : Die Gesamtheit der Kenntnisse und Fähigkeiten, die Individuen zur Lösung von Problemen einsetzen. Wissen basiert auf Daten und Informationen, ist im Gegensatz zu diesen aber immer an eine Person gebunden.[30]

Als eine Grundüberzeugung des Web 2.0 gilt die Nutzung der kollektiven Intelligenz. Hierbei geht es um die systematische Nutzung des kollektiven Wissens, welches gemeinschaftlich zusammengetragen wurde. Ausgehend von der Annahme: "Die Masse weiß mehr als der Einzelne."[31] Je mehr Nutzer teilhaben, desto größer wird der Wert, der am Ende dabei heraus kommt. Das Kollektiv steht im Mittelpunkt der Social Web Anwendung und ist verantwortlich für dessen Gestaltung.[32]

3.3 Social Collaboration

Collaboration ist das gemeinsame Bemühen von mehreren Einzelpersonen oder Arbeitsgruppen, um eine Aufgabe zu bewältigen oder ein Projekt auszuführen. Hierbei können die Projektteams sowohl räumlich als auch organisatorisch getrennt sein.[33]

Grundsätzlich unterscheidet sich Social Collaboration von der klassischen Collaboration lediglich durch die digitale Ebene, auf der ein Großteil der Arbeit stattfindet. Nach dem Gedanken der kollektiven Intelligenz erarbeitet das Kollektiv gemeinsam die Lösung zu einer gestellten Aufgabe. Dies lässt sich grundsätzlich in allen Bereichen einsetzen, welche auf Zusammenarbeit von Menschen ausgelegt sind. Gerade im Bereich der Wirtschaft kann dies gewinnbringend genutzt werden, beispielsweise:

- die Verwendung im Werkzeug-, Fahrzeug- und Maschinenbau
- die Verwendung in der Zusammenarbeit mit Kunden
- Einsatz bei der internen Zusammenarbeit großer Unternehmen

3.4 Forum

Siepermann definiert ein Forum als:

"Ein System, das es Teilnehmern ermöglicht, asynchron miteinander zu kommunizieren. Foren sind i.d.R. flach hierarchisch organisierte Diskussionsplätze, die auf bestimmte Themengebiete fokussiert sind. Die Teilnehmer können dort eigenhändig neue, zum Oberthema passende Themen erstellen, sog. Threads, Threads über neue Beiträge kommentieren, bewerten oder sich für Beiträge anderer Nutzer bedanken."[34]

Die Anzahl an Foren, die im World Wide Web existieren, sind längst nicht mehr zählbar. Sie beschäftigen sich mit verschiedensten Themen aus allen Bereichen des Lebens. Hier kann jeder mitmachen, mitreden und sich mit anderen austauschen. In Foren treffen Gleichgesinnte aufeinander, tauschen sich mit Halb- und Vollexperten aus und diskutieren über Meinungen und Kommentare der anderen Nutzer. Auch wer im Internet nach Hilfe sucht, wird mit Sicherheit in einem Forum fündig.[35]

3.5 Gefahr der Foren

Durch die Vielzahl an Foren entsteht allerdings auch eine gewisse Gefahr für Nutzer, die auf der Suche nach einer Problemlösung sind. Der Nutzer kann sich nie sicher sein, wer die andere Person im Forum ist und wie umfangreich sein Wissen um das gefragte Thema ist. Er läuft also Gefahr eine Antwort von einer Person zu erhalten, die sich mit dem Thema nur minimal auskennt, es trotzdem für notwendig hält, seine Antwort zu hinterlassen. Der Schutzmantel der Anonymität lockt gerne Pseudo-Experten, Hobby-Psychologen und Möchtegern-Ärzte zum Vorschein, die mit ihrem Halb – oder ganz fehlendem Wissen, Unfug oder gar gefährliche Aussagen treffen.

Nutzer spielen gerne Experten, da es ihnen ein gutes Gefühl gibt, als qualifizierter Fachmann dazustehen.[36]

Dem Nutzer bleiben also nur die beiden Optionen, einer Aussage einer fremden Person, von der er nicht weiß in wie weit diese Person tatsächliches Wissen auf diesem Gebiet besitzt, zu vertrauen oder diese zu ignorieren und weiterhin auf der Suche nach einer Problemlösung zu sein.

3.6 Social Costumor Relationship Management

Social Media: Beschreibt eine Vielzahl digitaler Medien, Anwendungen und Technologien des Web 2.0, deren Eigenschaft es ist, Nutzern über bestimmte Plattformen im Internet zu ermöglichen, durch Nachrichten und Kommentare in Beziehung zueinander zu treten und miteinander kommunikativ zu interagieren.[37]

Social Media stellt einen neuen Zugangspunkt für das bisherige Customer Relationship Management, kurz CRM, dar. Die einzig zu überwindende Hürde liegt in der Frage, wie Technologien wie Foren, Feedback Tools, Blogs, Wikis und Community Plattformen in die bereits existierenden CRM Systeme eingebunden werden könnten. Das Miteinbeziehen der Nutzer von Social Media Plattformen wird auch als Social CRM bezeichnet. Das Social CRM zielt darauf ab, die Kundenbindung und den Kundenservice auf soziale Medien auszuweiten. Das langfristige Ziel des Social CRM liegt darin, die Kundenzufriedenheit zu steigern. Für Unternehmen ist es wichtig, dort präsent zu sein, wo Nutzer ihre Meinung äußern, Kaufentscheidungen treffen und Produktinformationen erhalten. Social CRM ermöglicht es dem Unternehmen:

- schnell allen Nutzern Informationen zukommen zu lassen, die an dem Unternehmen oder ihren Produkten interessiert sind.
- Diskussionen über seine Marken zu verfolgen und in Echtzeit Marktdaten und Feedback zu sammeln.
- Erfahrungsberichte von Kunden zu erhalten, auszuwerten und darauf zu reagieren.
- sich Problemen anzunehmen und das Vertrauen des Kunden wiederherzustellen
- Verbesserungs- und Optimierungswünsche von Kunden zu bestehenden Produkten entgegen zu nehmen.[38]

Die Kommunikation zwischen Unternehmen und Kunden verläuft dabei auf verschiedene Arten, welche schematisch dargestellt werden können:

- 1/n

Die Kommunikation richtet sich an mehrere Personengruppen. Dabei werden einzelne Botschaften an alle gerichtet, die die Social Media Plattform nutzen

- 1/1

Die Kommunikation richtet sich direkt vom Unternehmen zum Kunden.

- 1/1/n

Die Kommunikation findet indirekt mit dem Kunden statt über Posts und Diskussionen. Die Kunden können jederzeit einzelne Botschaften weitertragen, indem sie diese teilen.[39]

Die dabei aufkommenden Daten sollten durch Data Warehouse Management und Software Lösungen im CRM-Bereich erfolgen. Möglich ist es auch, durch den Einsatz eines ERP Systems oder einer Lösung im Bereich Business Intelligence, den Prozess zu unterstützen. Doch die eigentliche Hürde dieser aufkommenden Daten besteht darin, zu unterscheiden zwischen den wirklich wertvollen und weniger wertvollen Informationen.[40]

3.7 Social CRM in der Forenpraxis

Wenn sich Unternehmen Gedanken über das Social Media Auftreten machen, geht es meist um die größten und bekanntesten Plattformen wie Facebook, Twitter und Youtube. Doch am stärksten unterschätzt wird der vermutlich älteste Teil des Social Web, welcher inhaltlich die größte Tiefe bietet.[41]

Foren sind höchst relevant für die Reputation eines Unternehmens, Marke und Produkts, daher sollten Unternehmen gerade in diesem Bereich aktiv werden. Durch die Vielzahl an verschiedenen Foren wird dies allerdings mühselig, da man alle Foren dauerhaft im Blick halten müsste. Außerdem können Mitarbeiter nur duch konstruktive Beiträge im Rahmen der laufenden Diskussion zum Imageaufbau des Unternehmens beitragen, allerdings auch nur, wenn dieser Mitarbeiter als solcher innerhalb des Forums zu identifizieren ist.[42]

Die bessere Alternative besteht darin, ein eigenes zentrales Forenportal zu erstellen, welches für Nutzer als erste Anlaufstelle identifiziert werden kann. Ein eigenes Forum erlaubt es einem Unternehmen deutlich stärker die geführten Diskussionen und Beiträge zu steuern und zeitnah auf neue Einträge zu reagieren. Außerdem wird bei einem eigenen Forum die im Vorfeld genannte Gefahr von Falschinformationen deutlich stärker eingegrenzt.

4. Content Management System

Ein Content Management System, kurz CMS, dient zur Erstellung und Verwaltung von Inhalten in Formen wie Text, Bild, Video und Ton und wird häufig von Betreibern von Websites genutzt. Das CMS erlaubt es dabei auch Nutzern ohne Erfahrung im Umgang mit HTML (Hypertext Markup Language), CSS (Cascading Style Sheet), Javascript und PHP (Hypertext Preprocessor), schnell und einfach Web-Content zu erstellen und zu bearbeiten. Die typische Funktionsweise des CMS ermöglicht es dem Nutzer dabei vordefinierte Bausteine zu benutzen, und diese nach Wunsch auf einem beliebigen Hintergrund anzuordnen.[43]

[...]


[1] § 4 Absatz 2 GPSG, vgl. https://dejure.org/gesetze/GPSG/4.html

[2] Zulässigkeit elektronischer Bedienungsanleitungen, vgl. https://www.noerr.com/de/newsroom/News/zul%C3%A4ssigkeit-einer-bedienungsanleitung-auf-cd-rom.aspx

[3] Definition einer Bedienungsanleitung, vgl. http://www.juraforum.de/lexikon/bedienungsanleitung

[4] @boox Definition, vgl. https://appadvice.com/app/atboox/1222865652

[5] Strompen 2015, S. 6

[6] Pepels 2002, S. 106

[7] Pepels 2002, S. 277

[8] Handbuch zur Erstellung von Betriebsanleitungen, S.5

[9] Handbuch zur Erstellung von Betriebsanleitungen, S.5

[10] Handbuch zur Erstellung von Betriebsanleitungen, S.9-20

[11] Handbuch zur Erstellung von Betriebsanleitungen, S. 21

[12] Biermann, Weißmantel, S. 81

[13] Biermann, Weißmantel, S. 84-93

[14] Biermann, Weißmantel, S. 95-99

[15] Handbuch zur Erstellung von Betriebsanleitungen, S. 22

[16] Handbuch zur Erstellung von Betriebsanleitungen, S. 22

[17] Handbuch zur Erstellung von Betriebsanleitungen, S. 23

[18] Handbuch zur Erstellung von Betriebsanleitungen, S. 23

[19] DIN EN 82079-1, vgl. http://www.maschinenrichtlinie-2006-42-eg.de/erstellen-von-anleitungen-das-sollten-sie-%C3%BCber-die-neue-din-en-82079-1-wissen

[20] Open Office, vgl. https://www.openoffice.org/de/ & Microsoft Office, vgl. https://www.microsoft.com/de-de/download/office.aspx

[21] FrameMaker, vgl. http://www.adobe.com/de/products/framemaker.html

[22] Help+Manual, vgl. http://www.helpandmanual.com/

[23] Ehlich, Noack, Scheiter, S. 27-29

[24] Ehlich, Noack, Scheiter, S. 30

[25] Ehlich, Noack, Scheiter, S. 31

[26] Schmeling S.50-52

[27] Definition Prosument, vgl. http://wirtschaftslexikon.gabler.de/Definition/prosument.html

[28] Griesbaum, S. 564

[29] Social Software Definition, vgl. https://www.e-teaching.org/technik/kommunikation/socialsoftware

[30] Wissen Definition aus dem Gabler Wirtschaftslexikon , vgl. http://wirtschaftslexikon.gabler.de/Definition/wissen.html

[31] Schmidt-Hertha et al. 2011: 14

[32] Alfert, 2014, S. 30

[33] Collaboration Definition, vgl. http://www.searchenterprisesoftware.de/definition/Collaboration

[34] Definition Forum von Siepermann aus dem Gabler Wirtschaftslexikon, vgl. http://wirtschaftslexikon.gabler.de/Definition/forum.html

[35] Haeusler

[36] Gefahr der Foren, vgl. https://www.so-gedacht.de/internetforen-moegliche-gefahren-beratung/

[37] Social Media Definition von Ibrahim Evsan , vgl. https://www.gruenderszene.de/lexikon/begriffe/social-media

[38] Social CRM Abschnitt Praxisbezug, vgl. https://de.ryte.com/wiki/Social_CRM

[39] Social CRM Abschnitt Praxisbezug, vgl. https://de.ryte.com/wiki/Social_CRM

[40] Social CRM Abschnitt Funktionsweise von Social CRM, vgl. https://de.ryte.com/wiki/Social_CRM

[41] Jodeleit, Abschnitt Tipps für Unternehmen, die in Foren aktiv werden möchten, vgl. https://www.lotsofways.de/unternehmen_unterschaetzen_foren/

[42] Jodeleit, Abschnitt Einleitung, vgl. https://www.lotsofways.de/unternehmen_unterschaetzen_foren/

[43] Definition Content Management-System, vgl. https://www.novalnet.de/ecommerce-lexikon/cms

Ende der Leseprobe aus 77 Seiten

Details

Titel
Entwicklung eines dynamischen, interaktiven Manuals mit Hilfe eines Content-Management-Systems
Untertitel
Die Systemlandschaft der Pirobase Imperia AG
Hochschule
Fachhochschule Bonn-Rhein-Sieg in Sankt Augustin
Note
2,7
Autor
Jahr
2017
Seiten
77
Katalognummer
V430958
ISBN (eBook)
9783668752115
ISBN (Buch)
9783668752122
Dateigröße
2267 KB
Sprache
Deutsch
Anmerkungen
Aufgrund eines NDA mit der pirobase GmbH wurden alle betroffenen Teile aus der hochgeladenen Arbeit entfernt.
Schlagworte
EPUB3, CMS, EPUB, Manual, Handbuch, Autoren, dynamisches Manual, interaktives Manual, Social Web
Arbeit zitieren
Stefan Weirauch (Autor), 2017, Entwicklung eines dynamischen, interaktiven Manuals mit Hilfe eines Content-Management-Systems, München, GRIN Verlag, https://www.grin.com/document/430958

Kommentare

  • Noch keine Kommentare.
Im eBook lesen
Titel: Entwicklung eines dynamischen, interaktiven Manuals mit Hilfe eines Content-Management-Systems



Ihre Arbeit hochladen

Ihre Hausarbeit / Abschlussarbeit:

- Publikation als eBook und Buch
- Hohes Honorar auf die Verkäufe
- Für Sie komplett kostenlos – mit ISBN
- Es dauert nur 5 Minuten
- Jede Arbeit findet Leser

Kostenlos Autor werden