Dieser Artikel untersucht typische Fehler in der sprachlichen Beschreibung technischer Systeme und zeigt auf, wie Missverständnisse in der technischen Dokumentation zu Projektfehlern führen können. Es werden Richtlinien vorgestellt, die auf Prinzipien der Linguistik und Psychotherapie basieren, um die Klarheit und Eindeutigkeit zu verbessern. Wichtige Aspekte sind die Verwendung aktiver Formulierungen, konsistente Terminologie, gängige Fachbegriffe, vollständige Informationen und präzise Qualitätsangaben. Die Methode der "W-Fragen" dient der Vollständigkeitsprüfung. Der Artikel betont die Notwendigkeit des Korrekturlesens durch Dritte, um Fehler zu vermeiden und die Qualität technischer Dokumente zu sichern. Durch die Anwendung dieser Empfehlungen und Qualitätssicherungsprozesse lassen sich Risiken minimieren und die Effizienz technischer Projekte steigern.
Diesen Artikel kostenfrei im PDF-Format herunterladen: HSTGC_Beschreibung_technischer_Systeme_Jul2020_DE.pdf (283 KB)Kaum jemand, der beruflich mit technischen Systemen zu tun hat, kommt umhin, von Zeit zu Zeit Dokumente zu erstellen, die diese Systeme beschreiben - sei es im Rahmen der Konzeption einer Neuanschaffung, der Erweiterung bestehender Systeme oder der Ausschreibung eines konkreten Systems. Während hierbei für viele Zwecke standardisierte Formate (beispielsweise technische Zeichnungen) genutzt werden können, ist es in vielen Fällen auch erforderlich, eine verbale Beschreibung eines Systems zu erstellen; dies ist überaus häufig bei der Formulierung von Konzepten oder Anforderungen der Fall.
Da die Zielgruppe für solche Dokumente in der Regel sehr breit gestreut ist (Projektverantwortliche, Dienstleister, Anbieter etc.) und sich sprachliche Beschreibungen in der Praxis nicht wirklich standardisieren lassen, steht der Autor eines solchen Dokuments vor einer besonderen Herausforderung: die Absichten des Autors müssen unabhängig etwaiger Vorkenntnisse von allen Lesern des Dokuments eindeutig und vollständig verstanden werden. In der Praxis stellt sich die Erreichung dieses Ziel als weitaus schwieriger als erwartet dar.
In den folgenden Abschnitten werden anhand einiger typischer Beispiele die wichtigsten und häufigsten Fehler, die bei der sprachlichen Beschreibung technischer Systeme begangen werden, erläutert und es werden Hinweise zur Erkennung und Korrektur dieser Fehler gegeben. Hierbei sollte jedoch beachtet werden, dass die beschriebenen Situationen und Richtlinien keinesfalls erschöpfend dargestellt werden, und dass das Dokument ebenfalls keinen Anspruch auf Vollständigkeit erhebt; die Erkennung und Beseitigung von Fehlern in verbalen Beschreibungen ist eine fachlich höchst anspruchsvolle Aufgabe, die in grossem Umfang nur von entsprechend ausgebildeten Personen durchgeführt werden kann. Ziel dieses Artikels ist es hingegen, eine grundsätzliche Sensibilisierung für das Thema zu erreichen und zur Vermeidung der wichtigsten Fehler beizutragen, um dem Leser die Möglichkeit zu geben, diese zukünftig von vorneherein zu vermeiden. Bei weitergehenden Fragen stehen unsere Fachberater von HST Greenfield gerne mit Rat und Tat zur Verfügung.
Für die Erläuterungen in diesem Dokument betrachten wir ein (fiktives) Projekt, bei dem das Telefonsystem eines Bürogebäudes um Alarmierungs- und Notruf-Funktionen erweitert werden soll. Hierbei sollen insbesondere die Flure, zwei Aufzüge und zwei barrierefreie Toiletten mit Notruftelefonen ausgestattet und das Telefonsystem an die Brandmeldeanlage angeschlossen werden. Die konkreten Beispiele entsprechen weitestgehend solchen Informationen, wie sie typischerweise in einer Anforderungsdokumentation im Rahmen von Ausschreibungen enthalten sind. Hierbei werden die Beispiele natürlich sehr verkürzt dargestellt, während teilweise bewusst nicht alle vorhandenen Fehler in den Beispielen korrigiert werden, um die Erläuterungen nicht über Gebühr zu verkomplizieren.
Unbedingt zu beachten ist, dass die angegebenen Regeln und Richtlinien grundsätzlich nur für solche Dokumente gelten, die sich an eine technisch vorgebildete Zielgruppe richten. Einer Person ohne entsprechendem Hintergrund muten derlei Formulierungen mitunter äusserst bizarr an - man erinnere sich an die Erheiterung, die der damalige Schweizer Bundesrat Hans-Rudolf Merz im Jahre 2010 im Plenum hervorrief, als er dort ein nach technischen Kriterien formuliertes Dokument verlas. Für fachfremde Personen war und ist nicht nachvollziehbar, wieso etwas vermeintlich Triviales wie die zolltarifliche Behandlung von Fleischerzeugnissen mit derart vielen komplizierten Erläuterungen beschrieben werden kann. Stattdessen wäre hier eine kurze, auf das entsprechende Publikum zugeschnittene und einfach nachvollziehbare - wenngleich unvollständige - Beschreibung des Sachverhalts geeigneter gewesen. Gleichzeitig hat die - seinerzeit verlesene - umfassende Beschreibung durchaus ihre Existenzberechtigung, denn in Zweifelsfällen muss (ausschliesslich zwischen zollrechtlichen Fachpersonen) eindeutig geklärt werden können, welches Fleischerzeugnis als gewürzt oder ungewürzt gilt.
Es gilt also grundsätzlich die Empfehlung, für die Präsentation eines Konzepts gegenüber nicht-technischen Personen (beispielsweise der Geschäftsleitung oder der allgemeinen Belegschaft) ein separates Dokument zu erstellen, in dem nur die wichtigsten Eckpunkte ohne zu viele Details erläutert werden, da die meisten dieser Details für dieses Publikum weder relevant noch aussagekräftig sind.
Die Hauptanforderung an die Dokumentation eines technischen Systems besteht darin, dass sie das System vollständig, korrekt und objektiv überprüfbar beschreibt. Hierbei bedeutet Vollständigkeit, dass alle Aspekte des Systems beschrieben werden, und dass die Beschreibung der Aspekte an sich keine Lücken aufweist. Die Korrektheit bezieht sich insbesondere auf die Abwesenheit von Fehlinformationen, zu denen auch widersprüchliche Angaben gehören; die objektive Überprüfbarkeit ermöglicht, das implementierte System ohne Interpretationsspielraum hinsichtlich der Erfüllung der Anforderungen zu validieren, was insbesondere bei der abschliessenden Abnahme des Systems eine wichtige Rolle spielt. Während es durchaus möglich ist, einige Aspekte eines Systems normiert zu beschreiben (z.B. mit Hilfe von Schaltplänen), kommen in den allermeisten Fällen natürlichsprachige Beschreibungen zum Einsatz, die aufgrund der fehlenden Normierung ein grosses Potential für Fehlinterpretationen oder Missverständnisse bergen. Die formalen Fehler, die zu diesen Problemen führen, werden fachsprachlich als "sprachliche Defekte" bezeichnet.
In allererster Linie resultieren diese sprachlichen Defekte aus der individuellen Wahrnehmung der Realität des Autors, die mitunter ganz erheblich von der Wahrnehmung der jeweiligen Leserschaft abhängt, und im Kontext dieser abweichenden Realitätswahrnehmung vollkommen unter-schiedliche Vorstellungen des beschriebenen Sachverhalts provoziert. Stellen Sie sich beispielsweise vor, ein Kollege erzählt ihnen, er wolle im kommenden Urlaub eine „weite Reise“ unternehmen. Wenn Sie selbst häufig in ferne Länder reisen, stellen Sie sich unter einer „weiten Reise“ vermutlich eine mehrstündige Flugreise vor, während Ihr Kollege, der seinen Heimatort selten verlässt, möglicherweise nur einen PKW-Ausflug nach Norditalien meint. Wenn er Sie nun fragt, welches Budget Sie für eine „weite Reise“ für angemessen halten, antworten Sie höchstwahrscheinlich mit einem knapp fünfstelligen Betrag, während für seine Zwecke ein hohes drei- oder niedriges vierstelliges Budget vollkommen angemessen wäre.
Bereits dieses recht triviale Beispiel zeigt, dass es aufgrund dieser unterschiedlichen Weltsichten zu groben Fehl-einschätzungen der gegebenen Information kommen kann. Im besten Falle erkennt der Leser eines Dokuments, dass eine Aussage klärungsbedürftig ist - beispielsweise dadurch, dass eine Aussage in seiner Weltsicht keinen Sinn ergibt oder unklar ist. In diesem Falle wird er vermutlich eine Rückfrage starten, die auf Seiten des Autors jedoch zu Zeit- und Kapazitätsverlust führt. Im schlimmsten Falle erkennt der Leser des Dokuments nicht, dass die Vorstellungen des Autors nicht mit seinen übereinstimmen, und liefert ein System, das für den beabsichtigten Einsatzzweck vollkommen unbrauchbar ist - im schlechtesten Fall führt dies zu einem überaus kostspieligen Scheitern des kompletten Projekts und zieht nicht selten längere juristische Auseinandersetzungen nach sich. Natürlichsprachige technische Dokumente werden häufig auch für die Ausschreibung von Systemen genutzt; hier ist es ebenfalls von hoher Wichtigkeit, dass die Beschreibung so eindeutig wie möglich formuliert wird, damit überhaupt eine Vergleichbarkeit der Angebote gegeben ist und eine sinnvolle Vergabeentscheidung getroffen werden kann.
Um die beschriebenen Situationen zu vermeiden, ist eine Vorgehensweise erforderlich, die die zugrunde liegenden Probleme erkennen und beheben kann. Die in diesem Dokument beschriebenen Methoden und Richtlinien, die genau dies für die am häufigsten auftretenden Probleme erreichen sollen, stammen in ihrer ursprünglichen Form aus den Disziplinen der Linguistik und der Psychotherapie. In einer Therapiesitzung geht es für den Therapeuten darum, die Denkweisen und die wahrgenommene Realität seines Patienten zu verstehen, um Diskrepanzen zu seiner selbst wahrgenommenen Realität aufzuspüren und diese Diskrepanzen als Therapieziel durch gezieltes Hinterfragen zu beseitigen. Genau diesen Ansatz verfolgt die in diesem Dokument beschriebene Methodik: Die Realitäts-wahrnehmung des Autors soll verstanden und hinterfragt werden, um mögliche Differenzen zu einer angenommenen Realitätswahrnehmung des Lesers aufzuspüren und zu beseitigen.
Dadurch, dass die Autoren technischer Dokumente aufgrund ihrer Vorkenntnisse des jeweiligen Fachbereichs und der Arbeitsweise ihrer Unternehmen und Kollegen tendenziell dazu neigen, diese Vorkenntnisse auch seitens Dritter als gegeben und selbstverständlich anzunehmen, führt die Anwendung der beschriebenen Methodik in aller Regel zu einem umfangreicheren Dokument, da im Zuge der Methodenanwendung fehlende Informationen ermittelt und dem Dokument hinzugefügt werden. Ein Anwachsen des Dokumentumfangs ist hierbei keine unerwünschte Nebenwirkung, sondern zeigt, wie viele Hintergrund-informationen in einer nicht methodisch geprüften Ursprungsversion des jeweiligen Dokuments impliziert und daher unterschlagen wurden.
Anrufe von Notruftelefonen sollen durch unterschiedliche Ruftöne, die sich je nach auslösendem Notruftelefon unterscheiden, signalisiert werden
Beim Lesen dieses Satzes stellt sich unmittelbar die Frage „Wer signalisiert?“ Die passive Formulierung des Hauptsatzes lässt es zu, dass die ausführende Einheit (also das eigentliche Subjekt) nicht genannt werden muss, um einen gültigen Satz zu erhalten, wodurch unter Umständen wichtige Information verloren geht. In diesem Beispiel wäre es unter anderem auch denkbar, dass Notrufe über ein im Gebäude installiertes Lautsprechersystem signalisiert werden, obwohl nur die Signalisierung an den Telefonen der gerufenen Teilnehmer gemeint ist. Abhilfe schafft hier die Umformulierung in einen Aktivsatz, da hier die ausführende Einheit als Subjekt unbedingt genannt werden muss, um einen grammatikalisch korrekten Satz zu erhalten. Das Subjekt sollte hierbei am Satzanfang stehen, da so unmittelbar erkennbar wird, auf welches Element des Systems sich die Aussage bezieht.
Darüber hinaus beschreibt der Beispielsatz zwei unter-schiedliche Aspekte der Signalisierung: zum einen sollen Notrufe gesondert signalisiert werden, zum anderen soll anhand des Ruftons erkennbar sein, von welcher Stelle aus der Notruf abgesetzt wurde. Diese zwei Aspekte sollten auch in zwei separaten Sätzen beschrieben sein, da dies durch den Verzicht auf Verschachtelung die Verständlichkeit erhöht. Nebensätze sollten nur verwendet werden, wenn sie eine Bedingung formulieren (d.h. wenn der Nebensatz mit „wenn“ beginnt), andernfalls sollten die Nebensätze als separate Hauptsätze ausgeführt werden.
Eine korrigierte Form des Beispielsatzes könnte demnach lauten:
Ein Telefon soll einen Anruf mit einem vom Standard-Rufton abweichenden Rufton signalisieren, wenn der rufende Teilnehmer ein Notruftelefon ist. Das Telefonsystem soll jedem Notruftelefon einen eindeutigen Rufton zuordnen.
Formulierungen dieser Form klingen zwar merkwürdig (und wir alle haben in der Schule gelernt, dass derartiger Satzbau schlechter Stil ist), allerdings sollte man immer im Hinterkopf behalten, dass das Ziel beim Schreiben einer technischen Dokumentation nicht der Gewinn des Literaturnobelpreises ist, sondern die präzise und unmissverständliche Beschrei-bung des betrachteten Systems.
Die Notrufgeräte sollen mit einem dauerhaft beleuchteten Display ausgestattet sein
Bei der Lektüre dieses Satzes sollte sich der aufmerksame Leser unmittelbar fragen, was denn „Notrufgeräte“ sind. Bislang war nur von „Notruftelefonen“ die Rede, also stellt sich die Frage, ob es zusätzlich noch weitere Geräte zum Absetzen eines Notrufs gibt. In unserem Beispiel ist dies nicht der Fall, weshalb hier auch grundsätzlich nur der bereits eingeführte Begriff „Notruftelefon“ verwendet werden darf, um Verwirrung beim Leser zu vermeiden.
Anders verhält es sich, wenn zusätzlich zu den Notruftelefonen auch noch andere Notrufeinrichtungen (z.B. Feuermelder oder Totmannsender) zum Einsatz kommen sollen. In diesem Falle sollte einmal ein Sammelbegriff (z.B. „Notrufeinrichtung“) definiert und konsequent dann genutzt werden, wenn die Gesamtheit aller zum Notruf geeigneten Endgeräte gemeint ist, während in Fällen, die sich nur auf eine Klasse von Geräten beziehen, die Bezeichnung der entsprechenden Geräteklasse genutzt wird.
Auch hier weicht die Anforderung technischer Dokumente deutlich von den im Deutschunterricht erlernten Prinzipien ab - Synonyme sollten aufgrund der Gefahr von Miss-verständnissen grundsätzlich nicht verwendet werden, auch wenn dadurch die Situation entsteht, dass in zehn aufeinanderfolgenden Sätzen zehn Mal der Begriff „Notruftelefon“ erscheint.
Anrufe von Notruftelefonen oder Alarme der FDU sollen einen Bulk Call triggern
Vermutlich haben Sie diesen Satz nicht verstanden - und es ist davon auszugehen, dass es anderen ebenso geht. Gemeint ist tatsächlich:
Anrufe von Notruftelefonen oder Alarme der Brandmeldeanlage sollen einen Gruppenruf auslösen
Das Problem ist hier, dass die Abkürzung „FDU“ (für „Fire Detection Unit“) möglicherweise unter den Haustechnikern des betrachteten fiktiven Betriebs eine übliche Bezeichnung für die Brandmeldeanlage ist, und dass im Alltag der im umzurüstenden Gebäude arbeitenden Personen regelmässig von „triggern“ statt „auslösen“ und von „Bulk Calls“ statt „Gruppenrufen“ die Rede ist, während Personen ausserhalb dieses Kreises mit den entsprechenden Begriffen nichts anfangen können. Daher sollten Abkürzungen und Fachtermini grundsätzlich nur verwendet werden, wenn davon auszugehen ist, dass auch betriebsfremde Leser diese eindeutig verstehen - alternativ besteht auch immer die Möglichkeit, insbesondere häufig verwendete Abkürzungen zu Beginn des Dokuments zu definieren. Sofern dies nicht möglich oder gewünscht ist, sollte geprüft werden, ob für Fachbegriffe auch angemessene natürlichsprachige Ent-sprechungen gefunden werden können. Wichtig ist dies auch bei Begriffen, die in der Fachsprache des jeweiligen Auftraggebers vollkommen geläufig sind, von Dritten aber nur schwer oder gar nicht verstanden werden. Da es nicht einfach ist, solche Begriffe zu identifizieren, kann es hilfreich sein, in Zweifelsfällen den entsprechenden Terminus im Internet zu recherchieren. Eine zusätzliche Sicherheit bei der Identifikation problematischer Begriffe bietet auch das Gegenlesen des Dokuments durch einen unbeteiligten Dritten, wie es im Abschnitt 4.11 näher erläutert ist.
Der Besitzer des Gebäudes ist Mitglied im Verband der landesweit führenden Immobilienunternehmen
Sehr häufig finden sich solche Passagen in technischen Dokumenten - allerdings tut die beschriebene Mitgliedschaft zunächst hinsichtlich der beschriebenen Alarmierungs-szenarien nichts zur Sache, und sollte daher weggelassen werden, um das Dokument nicht mit überflüssigen Informationen unnötig aufzublasen. Wenn es gewünscht ist, den Auftraggeber kurz vorzustellen, so sollte dies ausschliesslich in einem einleitenden Abschnitt des Dokuments geschehen (z.B. dort, wo auch die Motivation und die Ziele des geplanten Vorhabens beschrieben werden). Anders verhält es sich natürlich, wenn sich durch diese Information weitere Anforderungen entstehen; diese sollten dann aber auch entsprechend begründet und vor allem genannt werden, beispielsweise:
Der Besitzer des Gebäudes ist Mitglied im Verband der landesweit führenden Immobilienunternehmen. Dieser Verband schreibt seinen Mitgliedern Mindestanforderungen an die in ihren Gebäuden installierten Alarmierungssysteme vor, die durch den Auftragnehmer zu berücksichtigen sind
Bei einem Anruf von einem Notruftelefon sollen alle an die Telefonanlage angeschlossenen Telefone klingeln
Die Frage, die sich dem aufmerksamen Leser nach diesem Satz aufdrängt, lautet: „Müssen auch die Telefone in den Aufzügen und auf den Toiletten klingeln, wenn ein Notruf abgesetzt wird?“ Höchstwahrscheinlich wird dies nicht der Fall sein, und es besteht die Gefahr, dass durch Verwendung des Quantors „alle“ eventuelle Ausnahmen nicht bedacht oder berücksichtigt wurden. Gleiches gilt für andere Universalquantoren wie „keine“, „immer“, „grundsätzlich“, „nie“ - wie auch für alle weiteren Begriffen, die Ausnahmen explizit ausschliessen. In unserem Falle sollen nicht ausnahmslos alle an die Anlage angeschlossenen Telefone bei einem Notruf klingeln, sondern nur die Tischtelefone der Mitarbeiter. Dies sollte dann im entsprechenden Satz auch genau so formuliert werden:
Bei einem Anruf von einem Notruftelefon sollen diejenigen Telefone gleichzeitig klingeln, die die Funktion eines Arbeitsplatztelefons erfüllen
Es gibt natürlich Situationen, in denen Universalquantoren tatsächlich die Ausnahmslosigkeit einer Situation ausdrücken sollen:
Bei Auslösen eines Alarms der Brandmeldeanlage sollen alle an die Telefonanlage angeschlossenen Telefone klingeln
Ein Feueralarm soll natürlich in allen denkbaren Bereichen des Gebäudes signalisiert werden, einschliesslich der Toiletten und der Aufzüge. Um zu vermeiden, dass eine Hinterfragung dieser Aussage notwendig wird, sollte die Ausnahmslosigkeit in diesem Falle explizit erwähnt werden, um dem Leser mitzuteilen, dass über die Ausnahmslosigkeit nachgedacht und sie für erforderlich gehalten wurde:
Bei Auslösen eines Alarms der Brandmeldeanlage sollen ausnahmslos alle an die Telefonanlage angeschlossenen Telefone, ungeachtet deren Standort und zugewiesenen Funktion
Die Notruftelefone (in Aufzügen, Toiletten etc.) sollen als Wandapparate ausgeführt werden
Häufig werden erläuternde Informationen in Form von Aufzählungen gegeben, die nicht selten durch Signalwörter wie „etc.“, „usw.“ oder eine Ellipse („...“) als unvollständig gekennzeichnet sind. Hierbei steht der Leser aber grundsätzlich vor dem Problem, quasi „erraten“ zu müssen, welche weiteren Elemente zu der jeweiligen Liste gehören, und welche nicht. Dies birgt unweigerlich die Gefahr, dass eine Person, die mit der Materie nicht so vertraut ist wie der Autor, falsche Interpretationen der zugehörigen Elemente vornimmt. Aus diesem Grund sollten Aufzählungen, sofern sie denn überhaupt notwendig sind, grundsätzlich abschliessend sein:
Die Notruftelefone (in Aufzügen, Toiletten und Fluren) sollen als Wandapparate ausgeführt werden
Auf diese Weise wird sichergestellt, dass alle betroffenen Elemente berücksichtigt wurden, und dass die Aussage auf keine weiteren Elemente zutrifft. Im beschriebenen Fall sollte auf die Aufzählung sogar komplett verzichtet werden, da aus vorangegangenen Aussagen bereits klar ist, dass Notruftelefone ausschliesslich in Aufzügen, Toiletten und Fluren zur Anwendung kommen - da alle Notruftelefone als Wandapparate ausgeführt werden sollen, erübrigt sich hier eine Konkretisierung durch die Aufzählung der Installationsorte.
Die Notruftelefone sollen unabhängig von ihrem Standort als Wandapparate ausgeführt werden
Es soll sichergestellt werden, dass Notrufe innerhalb akzeptabler Zeit beantwortet werden können
Abgesehen davon, dass dieser Satz noch einen Fehler nach Abschnitt 4.1 beinhaltet, muss man sich fragen, was als „akzeptable Zeit“ betrachtet wird. Während der Leser möglicherweise 15 Minuten als akzeptabel ansieht, meint der Autor tatsächlich eine Frist von lediglich einer Minute. Bei der Abnahme des fertig gestellten Systems stellt sich dann möglicherweise heraus, dass genau diese unterschiedliche Annahme zu einer Unbrauchbarkeit des Systems geführt hat, was ein äusserst kostspieliges Scheitern des Projekts mit anschliessender (praktisch aussichtsloser) Suche des Schuldigen in langwierigen juristischen Auseinander-setzungen zur Folge haben kann. Aussagen sollten daher grundsätzlich objektiv überprüfbar, beispielsweise durch Angabe einer konkreten Metrik, formuliert werden, da persönliche Interpretationen dann keine Rolle spielen. Betroffen sind hier grundsätzlich Begriffe wie „so schnell wie möglich“, „kurzfristig“, „in akzeptabler Zeit“ oder auch „ausreichend“, „ausgezeichnet“, „wenige“, „viele“ oder sonstige nicht quantifizierte Qualitäts- und Quantitätsbegriffe. Darüber hinaus sollte auch dargestellt werden, auf welche Weise das Qualitätsziel zu erreichen ist:
Notrufe müssen in jedem Falle innerhalb von 60 Sekunden beantwortet werden. Zunächst soll für 30 Sekunden ein interner Gruppenruf erfolgen, bei Nichtbeantwortung des Gruppenrufs soll das System den Notruf zur Feuerwehr weiterleiten. Die Feuerwehr ist in der Lage, jeden eingehenden Notruf innerhalb von 30 Sekunden zu beantworten.
Von den Notruftelefonen in den Toiletten sollen Röchelanrufe möglich sein
Dieser Satz beschreibt nur dann eine Anforderung an das Alarmierungssystem vollständig, wenn eindeutig bestimmt ist, was mit dem Begriff „Röchelanruf“ gemeint ist. Dementsprechend muss unbedingt definiert sein, wann ein „Röchelanruf“ vorliegt, und wie darauf zu reagieren ist. Hinter dem scheinbar simplen Begriff „Röchelanruf“ steht also ein komplexer, erklärungsbedürftiger Vorgang: Wenn ein Anrufer beispielsweise auf der Toilette zu kollabieren droht (oder beim Umstieg vom Rollstuhl auf die Toilette oder zurück stürzt) und zwar noch in der Lage ist, den Telefonhörer abzuheben, anschliessend aber weder wählen noch kommunizieren kann, müssen dennoch, auch ohne sprachliche Kommunikation, Rettungsmassnahmen in die Wege geleitet werden. Die Schwierigkeit in der Erkennung solch komplexer Sachverhalte ohne ausreichende Beschreibung liegt darin, dass dem Autor analog zu Abschnitt 4.3 in der Regel vollkommen klar ist, was mit dem jeweiligen Begriff gemeint ist, während sich die damit beschriebene Komplexität aber einem Leser möglicherweise nicht erschliesst. Dementsprechend lassen sich derartige Fehler am einfachsten auffinden, wenn das Dokument einem Dritten wie in Abschnitt 4.11 beschrieben zum Korrekturlesen vorgelegt und insbesondere auf die Beantwortung der sogenannten W-Fragen (Abschnitt 4.10) geachtet wird. Eine vollständige Beschreibung des Sachverhalts „Röchelanruf“ könnte beispielsweise wie folgt aussehen:
Hebt ein Teilnehmer den Hörer eines der Notruftelefone in den Toiletten ab und führt binnen 5 Sekunden nach Abheben des Hörers keinen Wählvorgang aus, ohne dass er den Hörer zurück auf die Gabel legt, so soll ein Gruppenruf wie in Abschnitt 4.7 beschrieben ausgelöst werden. Bei Annahme des Rufs soll das System eine voraufgezeichnete Ansage mit dem Wortlaut „Notfall in Raum (Raumnummer). Keine Sprechverbindung möglich.“ in stetiger Wiederholung bis zum Beenden des Gesprächs durch den annehmenden Teilnehmer abgespielt werden.
Alternativ wären hier auch Anforderungen denkbar, die statt der aufgezeichneten Ansage (oder nach einmaligem Abspielen) automatisch eine Sprechverbindung (über den Freisprech-Lautsprecher des Telefons) herstellen, um mit der verunglückten Person sprechen zu können. Diese möglichen Varianten zeigen, dass es unumgänglich ist, komplexe Prozesse präzise zu beschreiben.
Praktisch immer müssen technische Systeme mit anderen technischen Systemen zusammenspielen. Damit dieses Zusammenspiel einwandfrei funktioniert, muss sichergestellt sein, dass die eventuell zu nutzenden Schnittstellen von beiden Seiten der jeweils betroffenen Systeme vollständig unterstützt werden. Aus diesem Grunde ist es unabdingbar, die jeweils miteinander in Interaktion tretenden Systeme zu identifizieren und zu beschreiben, damit der Leser des Dokuments prüfen kann, ob die beschriebene Interaktion technisch realisierbar ist:
Das um Alarmierungsfunktionen zu erweiternde Telefonsystem wird unter Verwendung einer Telefonanlage des Fabrikats „Quasselstrippe QS2000“ betrieben. Die Komponenten des zu installierenden Alarmsystems sollen diese Telefonanlage ohne technische Modifikationen an der Telefonanlage ansteuern können.
Für das betrachtete Beispiel fällt auf, dass neben der Telefonanlage auch die Brandmeldeanlage mit dem Alarmierungssystem (siehe Abschnitt 4.3) interagiert - somit sollte auch die genaue Bauartbezeichnung der Brandmeldeanlage, zumindest aber die unterstützen Schnittstellen, in der Anforderungsdokumentation erwähnt sein. Eine einfache Identifikation der betroffenen Systeme lässt sich dadurch bewerkstelligen, dass ein einfacher Verschaltungsplan des Gesamtsystems mit den jeweiligen Signalwegen erstellt wird. Alle Anlagen, die direkt mit dem betrachteten Teilsystem durch einen Signalweg verbunden sind, sollten in der Dokumentation erwähnt werden.
Zusätzlich zu funktionalen Anforderungen im Zusammenhang mit Randsystemen können aber auch weitere, sogenannte „nichtfunktionale“ Anforderungen bestehen, die das betrachtete Teilsystem einschränken. Hierzu zählen beispielsweise rechtliche Beschränkungen (siehe das Beispiel im Abschnitt 4.4) oder auch bauliche Einschränkungen:
Die zu installierenden Notruftelefone dürfen aufgrund baulicher Einschränkungen eine maximale Breite von 16 cm haben
Eine fehlende Randbedingung ist im Nachhinein nur schwer zu identifizieren - aus diesem Grund sollten derartige Einschränkungen bereits vor der Erstellung eines Dokuments in einem vorgelagerten Analyseschritt vollständig identifiziert und verifiziert werden. Es wäre äusserst ärgerlich, wenn sich die Inbetriebnahme des beispielhaften Alarmsystems um mehrere Tage verzögert, da sich beim Montieren der Notruftelefone herausstellt, dass diese um wenige Millimeter zu breit sind.
Da die Prüfung, ob ein Sachverhalt vollständig und abschliessend beantwortet wurde, durchaus eine erhebliche Herausforderung darstellen kann, wird eine Methode benötigt, mit der sich möglichst unkompliziert und schnell herausfinden lässt, ob der Autor möglicherweise entscheidende Informationen unterschlagen hat. Bereits Schülern wird beigebracht, beim Absetzen eines Notrufs an eine Rettungsleitstelle unaufgefordert die sogenannten „W-Fragen“ zu beantworten; das gleiche Prinzip kann sich auch auf Aussagen in einem technischen Dokument als nützlich erweisen, um zu prüfen, ob ein Vorgang vollständig beschrieben wurde:
- Wer [agiert]?
- Was [geschieht]?
- Wann [geschieht es]?
- Wo [geschieht es]?
- Wie [geschieht es]?
- Warum [geschieht es]? (optional)
Wenden wir nun diese Fragen auf die folgende Aussage an:
Der Hausmeister muss einen Fehlalarm quittieren.
Diese Aussage beantwortet bereits zwei der genannten Fragen, lässt die übrigen jedoch offen:
Wer? Der Hausmeister. Was? Fehlalarm quittieren.
Es wäre also noch zu spezifizieren, wann der Alarm quittiert werden muss (innerhalb von 30 Sekunden), wo dies getan wird (an einem Telefon-Endgerät), wie es getan wird (durch Wählen des Codes 999) und, falls dies für das Verständnis der Situation wichtig ist, auch wieso (weil der Alarm wie in Abschnitt 4.7 beschrieben nach 30 Sekunden bei der Feuerwehr aufläuft). Eine vollständige Beschreibung des Sachverhalts müsste also lauten:
Der Hausmeister muss einen Fehlalarm innerhalb von 30 Sekunden an einem beliebigen Telefon-Endgerät durch Wahl des Codes 999 quittieren, da der Alarm nach Ablauf dieses Zeitraumes bei der Feuerwehr aufläuft und einen vermeidbaren Rettungseinsatz auslöst.
Ganz grundsätzlich empfiehlt es sich unbedingt, ein erstelltes Dokument (möglicherweise auch bereits begleitend zu seiner Erstellung) Korrektur zu lesen bzw. durch einen Nicht-Autor Korrektur lesen zu lassen.
Zum einen können dadurch orthographische und grammatikalische Fehler aufgespürt werden: Ein Dokument, das ohne schwere Rechtschreib- oder Grammatikfehler präsentiert wird, wirkt nicht nur professioneller, bei Dokumenten, die eine Vielzahl solcher Fehler enthalten, besteht darüber hinaus auch grundsätzlich der Verdacht, dass das Dokument auch inhaltliche Fehler enthält (da es vermutlich nicht einem Lektorat unterzogen wurde). Somit kann ein orthographisch und grammatikalisch einwandfreies Dokument auch zur Vertrauensbildung in die dort präsentierten Inhalte beitragen.
Zum anderen können durch ein Lektorat auch inhaltliche Fehler und Probleme, die dem Autor aufgrund seiner eigenen, natürlichen Voreingenommenheit gegenüber seinem Werk entgangen sind, identifiziert werden - so fallen einem Dritten unverständliche Formulierungen und erklärungsbedürftige Begriffe wesentlich eher auf als einem der Autoren des Dokuments. Als Leitfaden für das Korrekturlesen kann die Checkliste aus Anhang A dieses Dokuments dienen.
Idealerweise sollte es sich bei den Lektoren des Dokuments um betriebsfremde Personen handeln, da nur diese beispielsweise intern genutzte Fachbegriffe (siehe Abschnitt 4.3) als erklärungsbedürftig identifizieren können. Hierbei kann es ausreichend sein, auf Kollegen aus einer anderen Abteilung zurückzugreifen, bei komplexen und umfangreichen Dokumenten kann es jedoch auch sinnvoll sein, einen auf Qualitätssicherung spezialisierten Dienstleister (z.B. die HST Greenfield GmbH) mit dem Korrekturlesen des Dokuments zu beauftragen. Hierbei besteht der Vorteil, dass die Fachleute eines solchen Dienstleisters über umfangreiche Erfahrung im Lektorat technischer Dokumente verfügen und auch Befunde ermitteln können, die einer ungeübten Person entgehen.
Aufgrund der Vielzahl möglicher sprachlicher Fehler beim Verfassen technischer Dokumente und deren recht schwieriger Auffindbarkeit ist es fast unmöglich, ein tatsächlich fehlerfreies Dokument zu erstellen. Durch die Beachtung einiger Regeln und insbesondere das Korrekturlesen durch einen unabhängigen Dritten lässt sich die Fehlerquote jedoch drastisch reduzieren, so dass ein Grossteil der durch fehlerhafte Dokumente entstehenden Risiken wie erforderliche Rückfragen, unterschiedliche Interpretationen oder Streitigkeiten zu qualitativen Aspekten deutlich verringert werden kann. Ganz grundsätzlich empfiehlt es sich, die Prozesse in Projekten, die die Erstellung technischer Dokumente erfordern, dahingehend anzupassen, dass eine grundsätzliche Überprüfung aller erstellen Dokumente stattfindet, bevor diese an Dritte weitergegeben werden. Gerade bei umfangreicheren Dokumenten und Projekten sollte in diesem Zusammenhang auch überlegt werden, ob diese Qualitätsprüfung an einen externen Dienstleister mit Spezialisierung auf derartige Reviews ausgelagert werden sollte, um den maximalen Nutzen aus dieser Massnahme zu ziehen, ohne dabei die Kapazitäten des Projekt-Teams durch den entstehenden Zusatzaufwand unnötig zu belasten.
Gerne erläutern wir Ihnen weitere Details zu den in diesem Artikel beschriebenen Themen bei einem persönlichen, unverbindlichen Gespräch mit unseren Beratern. Bitte zögern Sie nicht, uns zu kontaktieren: hello@hstgc.com
Wir beraten Kunden in der Schweiz und in Europa.
Sprechen Sie uns an, gerne erläutern wir Ihnen ausführlich weitere Details.
HST Greenfield GmbH
Brühlmatten 9
5607 Hägglingen
Schweiz
Bürozeiten Mo. bis Fr. 8 Uhr bis 17 Uhr.
Telefon: +41 (44) 511 10 80
Email: hello@hstgc.com
MS Teams: Rolf Hunziker / Henning Schaefer
LinkedIn: HST Greenfield GmbH