Das Prinzip KISS

Keep it simple, stupid Mach’ es so ein­fach wie mög­lich clean-code-developer

Das Prinzip KISS besagt, dass Autoren eine mög­lichst ein­fache Beschrei­bung für Inhalte im Wiki wählen sollen. Leser sollen nicht an einer großen Menge an Details ersticken, die sie im Grunde nicht brauchen. Sie sollen den Blick auf die wirk­lich wich­tigen Dinge nicht ver­lieren. Ähn­lich wie “Spaghetti-Code” beim Program­mieren möchten Leser keinen “Spaghetti-Text” im Wiki vor­finden.

Auch wenn Leser einer Pro­dukt­doku­mentation nicht die primäre Ziel­gruppe für die ein­fache Sprache sind, helfen ihre Regeln den Autoren dabei, bessere Texte zu schrei­ben.

Die Regel zur Ver­meidung von schwe­ren Wor­ten oder Spezial­begrif­fen kann jedoch nicht ange­wendet werden. Begriffe der Domäne sind Teil der gemein­samen Sprache und müssen erhal­ten blei­ben. Ver­linkt man jedoch diese Worte und Begriffe mit dem Glossar, kann sich jeder Leser mit einem Klick die für das Ver­ständnis not­wen­digen zusätz­lichen Infor­mationen besor­gen. Die ein­fache Sprache ist spätes­tens dann ein Vor­teil, wenn im Team Per­sonen arbei­ten, deren Mutter­sprache nicht gleich der Domänen­sprache ist.

Keep it strictly simple Mach es konse­quent ein­fach. clean-code-developer

Das Prinzip KISS fordert von den Autoren, dass sie ganz konse­quent nur das beschrei­ben, was die Leser benöti­gen. Nicht mehr und nicht weni­ger. Das erfor­dert ein hohes Mass an Diszi­plin bei Autoren und Lesern gleicher­maßen. Es ist für einen Autor sehr viel schwerer, eine Infor­mation »auf den Punkt« zu bringen als ein­fach drauf los zu schreiben.

Klein anfangen ist die Devise. Gibt es kon­krete Rück­fragen der Leser, dann bietet es sich an, die Klä­rung für alle nutz­bar zu machen. So wird der Inhalt schritt­weise besser, bleibt aber schlank, dort wo mit einem kur­zen Satz alles gesagt ist.

»Weniger ist mehr« sagt ein Sprich­wort. Weniger Inhalt, auf den wir uns aber ver­lassen können hat mehr Wert als eine Unmenge an Doku­menten, denen wir nicht ver­trauen.

Simpli­city — the art of maxi­mizing the amount of work not done — is essen­tial. Ein­fach­heit — die Kunst, die Menge nicht getaner Arbeit zu maxi­mieren — ist essen­ziell. Manifest agiler Software-Entwicklung

Ein­fach bedeutet, dass wir eine Struk­tur ver­wenden, die es uns erlaubt, Wissen in über­schau­baren Portio­nen nach­haltig zu beschrei­ben. Autoren brauchen klare Regeln, die sie leiten, die ihnen helfen, die richtige Detail­tiefe in ihren Texten zu erreichen. Autoren brauchen eine vorgegebene Struktur, die ihnen hilft, Wissen sinn­voll und für Leser nach­voll­zieh­bar aufzu­teilen.