Sie fragen sich, wie ein Projekt in der Technischen Dokumentation im Allgemeinen abläuft und wie sich die Zusammenarbeit mit einem externen Technischen Redakteur gestaltet?
Wie bei den meisten Projekten, können auch in einem Dokumentationsprojekt verschiedene Phasen benannt, diese jeweils mit den entsprechenden Tätigkeiten gefüllt und daraus ein erster allgemeiner "Fahrplan" abgeleitet werden. Dieser kann dann in Abstimmung mit Ihnen an die spezifischen organisatorischen und inhaltlichen Anforderungen in Ihrem Unternehmen angepasst werden.
Grundsätzlich gilt: Da Projekte in der Technischen Dokumentation häufig mittel- bis langfristiger Natur sind und umfangreiche Einblicke in die Details des Dokumentationsgegenstands erfordern, ist dringend eine möglichst frühe Einbindung des Technischen Redakteurs in den übergeordneten Projektverlauf anzuraten, damit die benötigte Dokumentation pünktlich zum avisierten Marktstart oder Release-Termin – von Ihnen freigegeben – zur Verfügung steht.
-
Schritt 1: Ihre Projektanfrage
Sie wenden sich mit Ihrer konkreten Projektanfrage an dokumentum. dokumentum schätzt den Arbeitsaufwand anhand Ihrer Angaben ab, unterbreitet ein Angebot und Sie lösen die Bestellung aus.
Haben Sie noch nicht mit dokumentum zusammengearbeitet, müssen wir zunächst die Rahmenbedingungen der Zusammenarbeit abklären.
Aufgrund üblicher Einarbeitungszeiten und Dauer von Dokumentationsprojekten empfiehlt sich eine langfristige Zusammenarbeit, die auf mehr als nur ein Einzelprojekt ausgelegt ist. Das spart langfristig Zeit und Geld. Hierfür bietet sich die rechtliche Form der Kooperation mittels Rahmenvertrag an.
-
Schritt 2: Die Projektplanung
Vor dem eigentlichen Beginn der Arbeiten gilt es nun gemeinsam einen Konsens in Fragen der Zeit- und Aufgabenplanung zu finden, Verantwortlichkeiten festzulegen und Ansprechpartner zu benennen. Eine gute Planung ist die halbe Miete. Planen Sie deshalb auch Zeiten für gegebenenfalls erforderliche Zuarbeiten durch Ihre eigenen Mitarbeiter ein, wo erforderlich.
Lernen wir einander erst kennen, benötige ich vorab eine Einführung in die Arbeitsweise in Ihrem Unternehmen, um mich mit allen für die Dokumentation relevanten internen Abläufen und Strukturen bekannt zu machen.
Gibt es in Ihrem Unternehmen bislang keine konkreten Strukturen und definierten Prozesse zur Erstellung Technischer Dokumentationen, so müssen wir diese Details zu allererst erörtern und gemeinsam entsprechende Festlegungen treffen.
Gleiches betrifft die Festlegung sicherer Kommunikationskanäle für den Informationsaustausch und des vorrangigen Einsatzortes. Bei diesen Überlegungen sollten technische und organisatorische Möglichkeiten und Risiken abgewogen werden. Ein permanenter Einsatz vor Ort stellt dabei für mich erheblichen Mehraufwand dar (im Vergleich zur anteiligen oder vorrangigen Arbeit aus meinem eigenen Büro mit nur den aus technischer Sicht erforderlichen Aufenthalten vor Ort). Diese Abwägung stellt nicht zuletzt eine Kostenfrage dar, da ich meinen Mehraufwand natürlich an meinen Kunden weitergeben muss.
-
Schritt 3: Die Konzeption (optional)
Verfügen Sie bereits über ein Dokumentationskonzept oder ein Redaktionshandbuch, arbeitet dokumentum selbstverständlich entsprechend Ihrer Vorgaben – in diesem Fall ist kein gesondertes Konzept notwendig. Fehlen entsprechende Vorgaben, wie z.B. definierte Dokumentenkategorien und deren jeweilige Inhalte, erstellt dokumentum in Abstimmung mit Ihnen entweder umfassende Leitwerke solcher Art oder nur eine einzelne Projektkonzeption.
-
Schritt 4: Die Dokumentationserstellung
Sind die Projektvorbereitungen erledigt, beginnt die eigentliche Arbeit mit der Informationsbeschaffung und Redaktion der benötigten Dokumentation. dokumentum arbeitet dabei mit den von Ihnen vorgegebenen Werkzeugen1) oder eigenen Arbeitsmitteln2).
Sofern es kundenseitige Vorgaben bzw. Vorlagen zur Gestaltung und zum inhaltlichen Aufbau Ihrer Dokumentation gibt, arbeite ich selbstverständlich entsprechend dieser Richtlinien. Andernfalls werde ich dafür entsprechende Vorschläge machen und in Abstimmung mit Ihnen umsetzen (siehe Schritt 3: Konzeption).
Sie als Auftraggeber stellen dokumentum die benötigte Arbeitsbasis zur Verfügung. Das bedeutet die dokumentationsrelevanten Informationen und Unterlagen zum Dokumentationsgegenstand (soweit vorhanden), Kontakte zu den entsprechenden Ansprechpartnern in Ihrem Unternehmen und wo erforderlich Zugang zum Gegenstand selbst (z.B. in Form von Testmöglichkeiten vor Ort, via Internet oder was im Rahmen des speziellen Projekts notwendig ist).
-
Schritt 5: Der Review- und Freigabeprozess
Nach der Dokumentationserstellung führe ich mit den Projektverantwortlichen und den entsprechenden Ansprechpartnern ein Review der einzelnen Dokumente durch. In diesem Rahmen besteht die Möglichkeit der Korrektur, Korrektureinarbeitung und abschließenden Prüfung. Ein Dokument ist für mich mit der finalen kundenseitigen Freigabe fertiggestellt. Die Dokumentation wird in der vereinbarten Form und im vereinbarten Umfang an Sie übergeben.
-
Schritt 6: Der Projektabschluss
Nach der Fertigstellung der Dokumentation erfolgt die Übergabe der Quelldaten im vereinbarten Umfang, ggf. eine Nachbesprechung und die Rechnungslegung.
- Bei speziellen Kundenanforderungen hinsichtlich der zu Dokumentationszwecken anzuwendenden Hard- und Software sind diese vor Projektbeginn abzustimmen und die Arbeitsmittel gegebenenfalls kundenseitig zu stellen.
- Eigene Arbeitsmittel die dokumentum bevorzugt verwendet, sofern keine Kundenvorgaben bestehen: Redaktionssystem Madcap Flare, Textverarbeitung mit Microsoft Word, Satzaufgaben mit Adobe InDesign, Bildbearbeitung mit Adobe Photoshop, Grafiken, Zeichnungen und Illustration mit Adobe Illustrator oder Microsoft Visio, Übersetzungen mit SDL Trados Studio (Translation Memory) und Terminologie mit SDL MultiTerm, Projektplanung mit Microsoft Project.