Onlinedokumentation mit Flare 12: Any color you like

Mad­Cap hat eine neue Ver­si­on sei­nes Help Aut­ho­ring Tools „Fla­re“ her­aus­ge­bracht. Ich habe einen ers­ten Blick dar­auf gewor­fen.

Als ob die Erstel­lung einer Doku­men­ta­ti­on für den Tech­ni­schen Redak­teur nicht schon schwie­rig genug wäre, stellt eine Online­hil­fe noch eine grö­ße­re sprach­li­che und didak­ti­sche Hür­de dar.
Neben der kon­sis­ten­ten Benut­zer­füh­rung und der sach­lo­gi­schen Beschrei­bung des Pro­dukts muss eine Online­hil­fe auch sprach­lich und didak­tisch anders ange­fasst wer­den als eine Doku­men­ta­ti­on, die als Papier oder PDF erschei­nen soll: Ein­fach mal schnell noch eine Tabel­le dran kle­ben genügt nicht mehr. Wenn Papier auch gedul­dig sein mag – der Online-Nut­zer ist es nicht.
Er will auch auf sei­nem Smart­phone alle rele­van­ten Infor­ma­tio­nen schnell und sicher errei­chen, er will nicht lan­ge scrol­len oder blät­tern, geschwei­ge denn lesen. Eine For­mu­lie­rung wie die fol­gen­de geht da gar nicht:

„Lesen Sie bit­te die zu die­sem Pro­dukt gehö­ren­de Sicher­heits­in­for­ma­ti­on ins­be­son­de­re dann beson­ders sorg­fäl­tig, wenn Sie häu­fi­ger mit dem Pro­dukt in einer poten­zi­ell gefähr­li­chen Umge­bung ohne Auf­sicht durch sach­kun­di­ge Fach­kräf­te arbei­ten müs­sen.”

Das ist schon gedruckt eine Zumu­tung, auf dem Bild­schirm ist es das erst recht, selbst wenn man auf die höf­li­che Bit­te und das Per­so­nal­pro­no­men ver­zich­tet.
Bei Redak­teu­ren, die das The­ma Online­hil­fe ernst neh­men, wird zuneh­mend zuguns­ten einer schnel­le­ren Erfas­sung auf text­ar­me Anlei­tun­gen gesetzt. Bil­der erleich­tern die Erfas­sung, beweg­te Bil­der erst recht.
Aber nicht alle Sach­ver­hal­te las­sen sich gra­fisch trans­por­tie­ren. Man­che müs­sen die Viel­sei­tig­keit der Spra­che nut­zen, ihre Fähig­keit zu abs­tra­hie­ren und zu moti­vie­ren. Nur lei­der müs­sen Tex­te über­setzt wer­den.

Und dann kommt die Über­set­zung

Wenn Sie einen guten Über­set­zer haben und die­sen auch anstän­dig bezah­len, schafft er es viel­leicht, den oben genann­ten Satz auch in die Ziel­spra­che zu brin­gen, ohne den Leser zur Ver­zweif­lung zu trei­ben¹
Aber ange­nom­men, Sie haben als Tech­ni­scher Redak­teur die­se Her­aus­for­de­rung gemeis­tert und tat­säch­lich knap­pe und gut les­ba­re Sät­ze for­mu­liert, die auch fach­lich ein­wand­frei sind: Sie sind noch nicht ganz fer­tig, denn nach der Über­set­zung wird die Online­hil­fe ja noch publi­ziert.²
In der moder­nen Online­hil­fe wird ein Inhalts­ver­zeich­nis mit den jewei­li­gen Inhal­ten ver­knüpft und ein Such­in­dex auto­ma­tisch ange­legt (das soll­ten Sie auf jeden Fall ver­wen­den), denn nur mit dem Inhalts­ver­zeich­nis bzw. der Navi­ga­ti­on kommt der Benut­zer nicht weit. Danach wer­den alle Inhal­te in ein Tem­p­la­te gegos­sen, das das Aus­se­hen vor­gibt und gleich­zei­tig auf die Bild­schirm­grö­ße des Anzei­ge­ge­räts Rück­sicht nimmt: Bil­der wer­den ska­liert, Navi­ga­ti­on aus­ge­blen­det, um Platz zu spa­ren, Sät­ze wer­den umge­bro­chen. Das Ziel ist die Aus­ga­be für alle Gerä­te, die eine Soft­ware besit­zen, die HTML5 anzei­gen kann. Nun damit sind ohne Auf­wand auch nicht-euro­päi­sche Spra­chen dar­stell­bar, kön­nen Inhalt und Form sinn­voll getrennt wer­den.
Der Benut­zer soll davon nichts mer­ken: der Inhalt ist der Glei­che, egal auf wel­chem Gerät er ihn kon­su­miert. Und zwar ih in allen Spra­chen.

Umschal­ten

Was aber, wenn der Benut­zer zwar in einem eng­lisch­spra­chi­gen Land wohnt und dort ein Pro­dukt benutzt, dass in der Lan­des­spra­che ange­zeigt wird, die Inhal­te aber nicht ver­steht und nun Hil­fe in sei­ner Mut­ter­spra­che benö­tigt? Spa­nisch bei­spiels­wei­se? Oder der Soft­ware-Admi­nis­tra­tor kommt aus Indi­en, soll aber eine Ser­ver­farm in Ita­li­en ein­rich­ten und kann kein Ita­lie­nisch? Das Per­so­nal will aber benö­tigt eine ita­lie­ni­sche Benut­zer­ober­flä­che.
Bis­lang wur­de das meist so gelöst, dass sich der Admi­nis­tra­tor – um bei dem zwei­ten Bei­spiel zu blei­ben – die Infor­ma­tio­nen aus­ge­druckt hat und mit einem dicken Hand­buch bewaff­net (meh­re­re hun­dert Sei­ten sind fast nor­mal) neben dem Rech­ner sitzt und ver­sucht, den Inhalt des Hand­buchs mit der Dar­stel­lung auf dem Bild­schirm zusam­men zu brin­gen: Bin ich auf der rich­ti­gen Sei­te im Hand­buch? Wie heißt der But­ton auf Ita­lie­nisch?
Es wäre jetzt viel ein­fa­cher, der Admi­nis­tra­tor könn­te direkt auf dem Bild­schirm die Spra­che aus­wäh­len, die er bes­ser ver­steht. Das geht seit kur­zem mit Mad­Cap Fla­re 12.

Neben ande­ren Fea­tures, mit denen die neu­es­te Fas­sung bewor­ben wird, ist die­ses Fea­ture für den Nut­zer das wohl Sinn­volls­te. Gera­de, wer eine Hil­fe für einen inter­na­tio­na­len Leser­kreis publi­zie­ren möch­te und mit dem Gedan­ken spielt, nicht für jede Spra­che eine eige­ne Doku­men­ta­ti­on zu ver­wal­ten und dann im Pro­gramm mit­ein­an­der zu ver­bin­den, ist das ein sehr reiz­vol­ler Gedan­ke. Fla­re erlaubt es damit, alle Pro­jek­te, die wei­ter­hin getrennt vor­lie­gen, aus einem Pro­jekt her­aus zu ver­wal­ten und zu ver­öf­fent­li­chen. Der Leser erhält einen zusätz­li­chen But­ton, mit dem er sei­ne gewünsch­te Spra­che auf­ru­fen kann – und direkt auf der glei­chen Sei­te lan­det, aus der er die Spra­che auf­ge­ru­fen hat.
Zwar las­sen sich auf die glei­che Wei­se auch PDF zusam­men­pa­cken, indem alle Spra­chen in der glei­chen Rei­hen­fol­ge anein­an­der gehängt wer­den, dies wider­spricht aber kom­plett der Benut­zer­logik.

Bon­bon zum Schluss

Für den Redak­teur hat sich Mad­Cap noch ein Schman­kerl ein­fal­len las­sen: Inhal­te, die für den Über­ar­bei­tungs­pro­zess die Ände­rungs­ver­fol­gung nut­zen, wer­den mit Mar­kie­run­gen ver­se­hen, die für den Kor­rek­tur­lauf direkt in die PDF über­tra­gen wer­den kön­nen. Das erleich­tert bei lan­gen Doku­men­ten den Aus­tausch per PDF oder Word und kommt damit dem Wunsch vie­ler SMEs ent­ge­gen, die einen Inhalt nicht ohne papier­ähn­li­ches For­mat lesen möch­ten.
Der Bear­bei­tungs­pro­zess ver­liert damit eine der größ­ten Hür­den: Häu­fi­ges Nach­fra­gen, weil kei­ner der Betei­lig­ten die rich­ti­ge Stel­le im Text fin­det, ist ein Pro­duk­ti­vi­täts­kil­ler ers­ter Güte.

Kurz: Allei­ne wegen die­ser bei­den Fea­tures lohnt ein Umstieg auf Fla­re als Publi­shing-Lösung für Online- und auch Off­line-Doku­men­te.

Bild­quel­le: Mad­Cap Soft­ware

1. Wobei trotz bes­ter Über­set­zungs­leis­tung die­sem Satz immer anzu­mer­ken sein wird, dass er nur in der deut­schen Spra­che sei­nen Ursprung haben kann. ↩

2. Und selbst wenn Sie die Infor­ma­tio­nen in einem Druck­for­mat wie PDF aus­ge­ben, scha­det ein gut auf­be­rei­te­ter Inhalt dem Ver­ständ­nis kei­nes­wegs. Es ist näm­lich nicht so, dass die Benut­zer bereit sind mehr zu lesen, nur weil es gedruckt ist. ↩