Technische Dokumentation: Der Prozess.

Kommt Ihnen das bekannt vor?

• TechnischeDokumentationverursachtRampenstopp: Wichtige Kunden warten dringend auf die Lieferung der Maschinen. Die Maschinen stehen auch versandfertig im Lager. Doch noch hat die Druckerei die Betriebsanleitung nicht fertiggestellt. Und ohne Anleitung dürfen die Maschi- nen nicht zum Kunden – sagt das Geräte- und Produktsi- cherheitsgesetz. Der Druckerei kann man übrigens keinen Vorwurf machen: DiehatdieDruckdateijaerstvoreinpaarStundenbe- kommen ...

• TechnischeDokumentationführtzuReklamationen: Kurz nachdem das neue Fitnessgerät auf dem Markt war, läuftdasService-Telefonheiß.DieKundenbeschweren sich, dass die Bedienelemente ganz anders funktionieren, alsinderAnleitungbeschrieben.Siekommenmitdem Gerät nicht zurecht und wollen es zurückgeben.

• TechnischeDokumentationverdirbtdasmoderneImage: Nach Abschluss der Entwicklungsarbeiten fällt der Testab- teilung auf, dass der neuen grafischen Bedienoberfläche am PC ein kontextsensitives Hilfesystem fehlt. Das ist aber „state of the art“ und bei den Produkten des Mitbewerbs längst üblich.

Diese abstrakt geschilderten Fälle sind nicht aus der Luft ge-griffen.Siekommenvor!UnzufriedeneKunden,nichtkalku-lierbare Kosten für Nachbesserungen und eventuell sogar ju-ristische Auseinandersetzungen sind die Folge.

Wie sorgt man für zeitgemäße, vollständige und pünkt-liche Technische Dokumentation?

LetztlichmüsseneineganzeReihevonFaktorenzusammen-kommen, damit eine fehlerfreie, verständliche Dokumentation kostengünstig und termingerecht entsteht. Fragen wir aber erst einmal nach den notwendigen Voraussetzungen, die dafür unbedingt gegeben sein müssen.

Dazu gibt es eine klare Antwort: Das Erstellen der Technischen Dokumentation zu einem Pro-dukt ist eine eigenständige Aufgabe. Die Erstellung erfolgt nach einem definierten Prozess, der eingebettet ist in den Ge-samtprozessderProduktentwicklung.ErfülltwirddieAufgabevonMitarbeitern(TechnischenRedakteuren),diedafürausge-bildet sind und die dafür ein bestimmtes Budget haben.

Komplexe Prozesse – was ist mit dem Überblick?

An einer Produktentwicklung sind viele Fachleute beteiligt: Marketing-Verantwortliche, Produktplaner, Entwicklungsinge-nieure,Testingenieure,Logistiker,TechnischeRedakteure...

Die Abstimmung zwischen allen Beteiligten wird sehr erleich-tert,wenneseinenProzessplangibt,derVerantwortlichkeiten,MeilensteineundProzess-Schrittefestlegt.

DerRedakteuralsVerantwortlicherfürdieTechnischeDoku-mentation stimmt sich mit allen Beteiligten ab. Dabei klärt er insbesondere:• WannundwieistderInputfürdieTechnischeDokumen- tation verfügbar?• WannisteinPrototyp/Vorabproduktfertig(fürBeispiele, Fotos)?• WersinddieKorrekturleser?WannlesensieKorrektur (z.B.TesterwährendderTestphase)?• Wermachtggf.Normenrecherche,Gefahrenanalyse,Usa- bility-Test?• WelcherechtlichenRahmenbedingungensindzubeach- ten(Copyright,DokumentationvonPartnernfürzugeliefer- teBestandteiledesProdukts)?

Der Technische Redakteur hat viele Aufgaben:

• Inputanalysieren• Ggf.Normenrechercheanstoßen• Ggf.Gefahrenanalysedurchführen/anstoßen,daraus Warnhinweiseentwickeln(mitPrüfungdurchTÜV)• StrukturundArtderTechnischenDokumentationentwi- ckeln und abstimmen• Texteschreiben• Grafiken,Visualisierungenentwerfenunderstellen(bzw. durchGrafikererstellenlassen)• FotosdesProduktserstellenund(ggf.mitNachbearbei- tung)indieDokumentationeinbringen• Beispieleverfassen(ggf.mitEntwicklung,Test,...)• Korrekturläufedurchführen,dabeiKorrekturenabstimmen und einarbeiten• Übersetzung(en)inAuftraggeben• FormaleQualitätskontrolle(Lektorat)anstoßenundüber- wachen• DieDokumentationfertigstellen,produzierenundarchi- vieren,ggf.fürmehrereSprachen

Prozess gut - alles gut?

Technische Dokumentation: Der Prozess.

Ob der Technische Redakteur alle genannten Aufgabenhat oder noch weitere hinzukommen, hängt von der Art der Technischen Dokumentation ab. Wenn diese z.B. aus einem Videofilmbesteht, übernimmtderRedakteur auchdieRolleeinesDrehbuchautorsundRegisseurs. Prozess gut – alles gut!?

Ein klar definierter Prozess, abgestimmte Verantwortlichkeiten undeinTechnischerRedakteur,derseinHandwerkversteht,sind notwendige Voraussetzungen für gute Technische Doku-mentation. Aber all dies garantiert noch nicht, dass das Projekt „Technische Dokumentation“ wirklich gelingt. Natürlich gehört mehr dazu:

• EinesinnvolleRedaktionsumgebung(ToolsundTempla- tes)unterstütztunderleichtertdieArbeitdesRedakteurs.• DieDokumentationistgutstrukturiert(orientiertamLeser undseinenAufgaben)undmachteinschnellesAuffinden vonInformationenleicht(Suchhilfen).• DieDokumentationistnacheinheitlichenRegelnverständ- lich geschrieben. Ein klares Layout unterstützt das leichte Verstehen.• InternationalisierungundLokalisierungderDokumentation sindbeiallenAufgabenundProzess-Schrittenberücksich- tigt.

Das bietet cognitas.

• WirberatenSiebeiderDefinitiondesProzessesfürIhre Dokumentationserstellung.

• WirübernehmeneinzelneProzess-SchritteoderIhrege- samte Dokumentationserstellung.

• WirhabenzujederZeitdenvollenÜberblicküberIhre Prozesse.

• WirschulenIhreMitarbeiter.

Analysieren.Recherchieren.Strukturieren.

KICK-OFF ABSTIMMUNGPRODUKT &

DOKUMENTATION FERTIG

Schreiben.Beispiele erstellen.Fotografieren.

Korrekturlauf. Korrektureneinarbeiten.

Übersetzungen.

Qualitätssicherung.Satz und Produktion.Archivierung.

PLANUNG ENTWICKLUNG TEST

SoerreichenSieuns:

cognitas.Gesellschaft für Technik-Dokumentation mbH

cognitas MünchenAlteLandstraße6D-85521 OttobrunnTelefon: 0 89 / 6 10 01 – 1 00Telefax: 0 89 / 6 10 01 – 1 01www.cognitas.de | E-Mail: info@cognitas.de

cognitas PaderbornTechnologiepark9D-33100 PaderbornTelefon: 0 52 51 / 1 48 88 – 0Telefax: 0 52 51 / 1 48 88 – 23E-Mail: paderborn@cognitas.de

cognitas StuttgartAuberlenstraße13D-70736FellbachTelefon: 07 11 / 6 45 83 49Telefax: 07 11 / 6 45 83 51E-Mail: stuttgart@cognitas.de