Sie haben ein neues innovatives Produkt entwickelt oder stecken noch mitten in der Entwicklung. Je früher Sie uns einbinden, desto besser können wir Ihre Anforderungen und Wünsche einhalten. Das Konzept ist die Basis für eine gute Dokumentation. So, wie Sie Ihr Produkt planen, spezifizieren und dokumentieren, was es genau leistet, wird die Dokumentation ebenfalls in einem Konzept geplant. Viele Punkte, die im Konzept festgelegt werden, kennen Sie bereits und sind immer individuell auf Ihr Produkt zugeschnitten und mit Ihnen abgestimmt.
Konzeption
Unser Ziel: Optimale Dokumentation in der Entwicklungsphase
Wir erstellen das Konzept nach folgender Reihenfolge und Faktoren:
Was – Dokumentationsstruktur
Zielgruppen
Bestimmungsgemäße Verwendung des Produkts
Arbeitsumfeld
Sicherheitshinweise
Tätigkeiten / Funktionsweise
Wie – Layout und Gliederung
Grobgliederung
Dokumentationswerkzeug (Software und Tools)
Texte
Abbildungen/Grafiken
Layout- und Typografie
Wann – Planen und Organisieren
Ablauf mit Meilensteinen
Verantwortliche (Inhalts- und Layout-Freigaben)
Umfang
Zeitplan
Kostenschätzung
Konzeption in der Technischen Dokumentation
Wird überhaupt ein Konzept benötigt?
Welche Fragen sollten im Konzept erklärt werden?
Wird überhaupt ein Konzept benötigt?
Ein Technischer Redakteur kann natürlich auch ohne vorgeschaltete Konzeptphase mit dem Schreiben beginnen und die Dokumentation spontan entwickeln. Jedoch besteht dabei die Gefahr, dass es am Ende aus folgenden Gründen teurer wird und länger dauert:
- Im Laufe eines jeden Projekts sind viele Entscheidungen zu treffen. Diese Entscheidungen können entweder bereits im Rahmen eines vorgeschalteten Konzepts erfolgen oder aber erst unmittelbar beim Schreiben der Texte. Beides dauert gleich lange. Bis hier ist durch ein vorgeschaltetes Konzept also noch kein Gewinn an Zeit und Kosten erkennbar – allerdings auch kein Verlust.
- Viele Entscheidungen bedingen sich gegenseitig. Daher müssen später immer einige der zu Beginn getroffenen Entscheidungen wieder revidiert werden. Solange Sie noch am Konzept arbeiten, können Entscheidung schnell und mit geringen Kosten revidiert werden. Wenn jedoch schon mit dem Erstellen der Anleitung begonnen wurde, kann es langwierig und teuer werden. Sie müssen alle bis zu diesem Zeitpunkt Erstellte Inhalte wieder überarbeiten. Je mehr schon existiert, desto teurer wird es.
Welche Fragen sollten im Konzept erklärt werden?
Ein solides Dokumentationskonzept muss nicht sehr umfangreich sein, sollte aber zumindest folgende Schlüsselfragen beantworten:
- Anforderungen der Zielgruppe
Über welches Vorwissen verfügen Ihre Kunden bereits? Wie sind die Arbeitsabläufe? Was sind ihre primären Ziele und Aufgaben Ihrer Kunden? - Weitere zwingende Anforderungen
Welche fundamentalen Rahmenbedingungen sind zu berücksichtigen, wie z. B. Termine, Budget, Häufigkeit zukünftiger Überarbeitungen, Übersetzbarkeit. Muss sich die neue Dokumentation in ein bestimmtes Schema bereits existierender Dokumente einfügen? - Informationstypen
Welche Art von Informationen benötigen Ihre Kunden: allgemeine Grundlageninformationen, detaillierte Referenzinformationen, schrittweise Anleitungen? Muss auch allgemeines Domänenwissen über das Umfeld der Anwendung vermittelt werden oder reicht die reine Beschreibung der Produktbedienung? - Medien
Wird es ein gedrucktes Handbuch (PDF), eine kontextsensitive Online-Hilfe oder beides geben? - Dokumente
Welche Dokumente werden erstellt? Kommen alle Informationen in ein einziges Dokument oder werden verschiedene Anleitungen für unterschiedliche Anwendungszwecke und Benutzergruppen vorgesehen? - Navigation
Welche Navigationselemente sollen in den Dokumenten angeboten werden? Wo sind Links / Querverweise sinnvoll, wo nicht? - Struktur, Gliederung
Wie sollen die Dokumente strukturiert werden? Welche Kapitel / Topics sind vorzusehen? - Erstellung, Produktion
Welche Erstellungswerkzeuge werden verwendet? Können diese Werkzeuge auch alle heute und in Zukunft benötigten Fremdsprachen handhaben?
Möchten Sie noch mehr Informationen?
Wir unterstützen Sie dabei, Ihre Dokumente für Ihre Anforderungen und Ihren Bereich optimal aufzubereiten – sei es für den Service, im Maschinen-/Anlagenbau oder für Schulungen.