Wir Tech­ni­schen Redak­teu­re ken­nen das: „Mach mal ne Doku, wir brau­chen die Unter­la­gen bis zum xten!“ Zeit­lich ist das meist zu schaf­fen, den­ken wir und fra­gen schon mal die Inge­nieu­re, was sie in der Doku­men­ta­ti­on ger­ne hät­ten. Eine Betriebs­an­lei­tung soll es wer­den. Das Pro­dukt ist in der fast abge­schlos­se­nen Pro­to­typ-Pha­se, wir haben also kei­ne Mög­lich­keit, uns schon in vor­han­de­ne Infor­ma­ti­ons­quel­len ein­zu­ar­bei­ten, wir müs­sen dar­auf ver­trau­en, dass der Käu­fer schon weiß, war­um er das Pro­dukt haben will und was er damit anfan­gen kann. Und dann begin­nen wir zu schrei­ben. Bloß nicht!

Für eine Glie­de­rung eig­net sich prin­zi­pi­ell jede Text­ver­ar­bei­tungs- oder Visua­li­sie­rungs­soft­ware

Das Den­ken soll­te man jedoch nicht der Soft­ware über­las­sen, die ist dafür nicht gemacht. Die kann nur Null und Eins …

Denn was bei die­sem wohl bekann­ten Sze­na­rio her­aus­kommt, ist eine Pro­dukt­do­ku­men­ta­ti­on: ein mehr oder weni­ger ordent­lich zusam­men­ge­stell­tes Stück Pro­dukt­be­schrei­bung. 150 Sei­ten Text mit Dar­stel­lun­gen, wie toll das Pro­dukt ist und was es alles kann, gespickt mit tech­ni­schen Details und Tabel­len. Mal ehr­lich: das kann man nicht lesen. Und wir soll­ten jetzt nicht den Feh­ler machen und davon aus­ge­hen, dass ein vor­ge­bil­de­ter Leser das anders sieht als ein ange­lern­ter. Es ist für kei­nen Men­schen les­bar. So hat man das frü­her gemacht, als man dach­te, dass sich gute Pro­duk­te von allei­ne ver­kau­fen. Das tun sie aber nicht mehr.

Zunehmende Komplexität zwingt zur Antizipation

Der Leser von heu­te will in einer zuneh­mend kom­ple­xe­ren Welt nicht allei­ne gelas­sen wer­den mit dem Pro­dukt. Er hat kei­ne Zeit zum Aus­pro­bie­ren, er steht unter Zeit­druck, mit dem erwor­be­nen Stück pro­duk­tiv sein zu müs­sen. Das gilt für Kaf­fee­ma­schi­nen genau­so wie für Hoch­leis­tungs­frä­sen. Der Käu­fer hat zwar eine Vor­stel­lung von dem, was er mit dem Pro­dukt machen möch­te, aber kei­ne Ahnung, wie das gehen soll. Er besitzt nur einen ein­zi­gen Zugang zu dem Pro­dukt: unse­re Doku­men­ta­ti­on.

Und jetzt ste­hen wir in der Ver­ant­wor­tung: hel­fen wir ihm? Oder zei­gen wir ihm, dass es uns völ­lig schnup­pe ist, wie er damit wei­ter kommt, schließ­lich hat der das gute Stück ja schon gekauft und dadurch ist es sei­ne Ver­ant­wor­tung. Wie wür­den wir uns vor­kom­men, wenn uns klar wird, dass wir ein Pro­dukt gekauft haben, des­sen Her­stel­ler uns eigent­lich nur für eine Kuh hält, die er mel­ken kann?

Eine kur­ze Nabel­schau kann uns dabei auf den rich­ti­gen Pfad füh­ren: Was erwar­ten wir von einer Doku­men­ta­ti­on?

Visua­li­sie­rung eines Inhalts­ver­zeich­nis­ses (hier mit Omni­Graff­le)

Sei es ein Com­pu­ter oder ein neu­er Rou­ter, ein Küchen­mi­xer oder Rasen­mä­her – wir sind dar­auf ange­wie­sen, dass die Pro­ble­me, die mit dem Pro­dukt auf­tre­ten kön­nen, auch in der Doku­men­ta­ti­on ihren Wider­hall fin­den. Wie bedie­ne ich es, was tue ich, wenn es klap­pert? Wie schal­te ich es aus und wo bekom­me ich Ersatz­tei­le? Das sind kei­ne Fra­gen, die sich nur der uner­fah­re­ne Laie stellt – das geht auch den Spe­zia­lis­ten so. Die­se und vie­le ande­re mög­li­che Fra­gen müs­sen wir in unse­rer Doku­men­ta­ti­on vor­weg­neh­men. Eine gute Doku­men­ta­ti­on zeich­net sich dadurch aus, dass eine Fra­ge beim Benut­zer auf­taucht, er in die Doku­men­ta­ti­on schaut und fest­stellt, dass der Redak­teur auch dar­an schon gedacht hat, dass er gewillt ist, mir unter die Arme zu grei­fen. Und sei es nur, indem auf einen ande­ren Spe­zia­lis­ten ver­wie­sen wird.

Der Weg als Ziel

Wie aber macht man das? Wie kann ich vor­weg neh­men, wel­che Fra­gen der Benut­zer haben wird? Dadurch, dass wir eine ein­fa­che Rei­hen­fol­ge ein­hal­ten: erst den­ken, dann schrei­ben. Das mag tri­vi­al klin­gen, ist es aber meist nicht. Oft steht uns die eige­ne Vor­er­fah­rung im Weg, oft auch der Zeit­druck. Was dabei immer hilft, ist das Hin­ein­ver­set­zen in die Lage eines Benut­zers. Die­ses Sich-Hin­ein­ver­set­zen müs­sen wir dann doku­men­tie­ren. Dabei stel­len wir uns vor, dass auch der Benut­zer nicht vor der Maschi­ne steht, son­dern vor der Doku­men­ta­ti­on. Er klappt sie auf (oder star­tet die Online­hil­fe): was sieht er? Moti­viert es ihn zum Umblät­tern? Hat er den Ein­druck, er fin­det sofort das, was er sucht? Wir soll­ten es selbst ein­mal durch­spie­len: kann ich mei­ner Doku­men­ta­ti­on ver­trau­en?

Wohl­ge­merkt: noch sind wir in der Pla­nungs­pha­se, noch schrei­ben wir nicht. Das Schlimms­te, was uns in die­ser Pha­se pas­sie­ren kann, ist sie aus Angst vor Zeit­knapp­heit zu ver­kür­zen. Daher stel­len wir uns als Nächs­tes eine Glie­de­rung auf, eine Art Inhalts­ver­zeich­nis der anzu­spre­chen­den Punk­te. Die­se brin­gen wir – immer unter dem Aspekt der Vor­läu­fig­keit – in eine Rei­hen­fol­ge, die auch für den Benut­zer logisch erschei­nen kann. Mit die­sem vor­läu­fi­gen Inhalts­ver­zeich­nis haben wir schon mehr als die Hälf­te des Weges zurück gelegt. Jetzt erst fül­len wir die Punk­te mit Inhalt. Jetzt beginnt der hand­werk­li­che Teil, den unse­re Kun­den erwar­ten.

Aber ohne Schritt eins fal­len wir mit hoher Wahr­schein­lich­keit bei Schritt zwei auf die Nase.