Doku-Tipp N°4: Das Wording – oder wie man zu sagen pflegt.
Häufig sind Organisationen oder Firmen zu definierten Formulierungen, Bezeichnungen oder standardisierten Beschreibungen bestimmter Abläufe, Zustände oder Eigenschaften verpflichtet. Das kann damit zu tun haben, dass sie strenge gesetzliche Bestimmungen, technische (Betriebs-)Normen, vertragliche Vereinbarungen, strategische PR und/oder markenrechtliche Rahmenbedingungen einzuhalten haben.
Aus diesem Grund kann es vorkommen, dass neue Dokumentationsinhalte gleich mehrere Stationen durchlaufen müssen (z.B. vom Dokumentator > Ingenieur > Projektmanager > Rechtsabteilung > Dokumentator) bis sie als “genehmigt” gelten. Idealerweise sollte so ein eigener allgemein akzeptierte/r “Jargon”, bzw. eine wachsende Textbank entstehen, sofern dieses Prozedere systematisch und übersichtlich abläuft.
Anzutreffen sind jedoch eher Szenarien (gerade in kleinen agilen Firmen) wo Text-Dateien kreuz-und-quer an alle Beteiligten versendet werden, mit der Bitte schnell einmal “Drüberzulesen”. Genehmigungsprozesse laufen dabei üblicherweise auf “Zuruf” ab und werden kaum nachvollziehbar protokolliert.
Kaum einer der Beteiligten kann sich (insbes. in Organisationen mit schnell wechselnden Personal) daran erinnern, ob die angefragten Inhalte nicht schon einmal (in einem anderen Projekt und Datei) verwendet / genehmigt wurden. Auf diese Weise wird ausgiebig Arbeitszeit “vernichtet” und die Text-Qualität nicht unbedingt erneuert / verbessert, sondern – im schlimmsten Fall – sogar merklich verschlechtert.
Tipp:
Übersicht schaffen. Inhalte pragmatisch in “kristalline” (dauerhafte, wiederkehrende) und “fluide” (flüchtige, vorübergehende) Einheiten trennen. Kristalline Inhalte sammeln, kodieren, verschlagworten und/oder mit einer unternehmensweiten Suchmaschine indizieren.
Wir stehen Ihnen mit Beratung und kostengünstigen Diensten zur Seite!
Kontaktieren Sie uns noch heute!
Anfrage senden
dokumentation dokumentationsprojekt Software development tipps wissen wissenswertes wording