Zu Anfang erfolgte eine Recherche der Inhalte in vorhandenen Dokumentationen, bei den Mitarbeitern des Unternehmens und auch externe Quellen wie Normen und Regelwerke. Im Anschluss wurden diese Informationen entsprechend einschlägiger Normen und Richtlinien für Technische Dokumentation grob strukturiert. So entstand das Grobkonzept.
Anschließend wurde das Layout für das Handbuch, einschließlich Gestaltung der einzelnen Informationstypen (Fließtext für Erläuterungen, Überschriften, Sicherheitshinweise...) erstellt.
Nun konnten die gewonnenen Informationen zu einem ersten Entwurf zusammengeführt werden. Die Texte wurden dann unter Berücksichtigung der Faktoren von Norm und Lesbarkeit ausformuliert. Nach der inhaltlichen Überprüfung des Entwurfs durch den Auftraggeber wurde das Handbuch fertig gestellt.
Das Handbuch (Text und Zeichnungen) wurde komplett mit dem OpenOffice-Paket umgesetzt. Die Erstellung als PDF erfolgte dann mit Adobe Acrobat.
Das Handbuch wird durch uns ständig aktualisiert.
Zuerst wurden die vorhandenen Texte geprüft auf Informationsgehalt, Formulierung, Lesbarkeit und Aktualität. Entsprechend der Ergebnisse der Prüfung wurden die Texte dann um den aktuellen Stand der Informationen erweitert. Nach der inhaltlichen Überprüfung durch unseren Kunden wurden die Produktbeschreibungen fertig gestellt und online veröffentlicht. Des Weiteren wurden Texte und Grafiken neu erstellt.
Hierbei wurde mit dem Content-Management-System (CMS) Typo 3 gearbeitet. Grafiken wurden hauptsächlich mit Adobe Photoshop erstellt.
Zuerst wurden über das vorhandene Handbuch erste Informationen über die Software recherchiert. Dabei wurde das Handbuch geprüft auf Informationsgehalt, Formulierung, Lesbarkeit und Aktualität (Dokumentencheck).
Dann wurde mit der Software eingehend gearbeitet, jede Funktion und jede Möglichkeit berücksichtigt. Im Anschluss wurden diese Informationen grob strukturiert, so entstand – parallel zur Entwicklung – das Grobkonzept des Softwarehandbuchs.
Anschließend wurden die Texte über die Software und deren Benutzung erstellt und nach einschlägigen Normen und bezüglich der Lesbarkeit formuliert. Abschließend erfolgte die inhaltliche Überprüfung des Entwurfs durch die zuständigen Mitarbeiter des Unternehmens. Das Handbuch wurde fertig gestellt und übergeben.
Einige Zeit darauf erfolgte eine Aktualisierung des Handbuchs, da die Software um neue Module erweitert wurde.
Die Erstellung und Umsetzung erfolgte mit MS Word. Grafiken wurden zum Teil durch den Kunden gestellt und in CorelDraw erstellt.
Zunächst wurde eine Recherche und Prüfung der vorhandenen Texte durchgeführt bezüglich Informationsgehalt, Formulierung, Lesbarkeit und Aktualität (Dokumentencheck). Darauf folgte das vertraut Machen mit dem Gerät und der Software. Parallel zur Entwicklung wurden die Texte und Screenshots über die Software und deren Benutzung gemäß geltender Normen und Richtlinien erstellt. Nach der inhaltlichen Überprüfung des Entwurfs durch den Auftraggeber wurde das Handbuch fertiggestellt und dem Auftraggeber als Datei übergeben.
Die Erstellung und Umsetzung erfolgte mit MS Word. Grafiken wurden zum Teil durch den Kunden gestellt und in CorelDraw erstellt.