Imagefilm – Technischer Redakteur

Die tekom scheint gerade voll durchzustarten, was das Werben von Nachwuchs angeht. Hier findet ihr einen Imagefilm:

Und jetzt das ganze noch bei youtube hochladen, liebe tekom, und ihr seid völlig WebZwoNull. Wenn schon “Medienberuf”, dann aber richtig
Jetzt auch bei youtube ;)

Und ich find den Film eigentlich gar nicht schlecht, wobei ich mich allerdings auch nicht mehr so recht in einen ratlos-bis-verzweifelten Abiturienten hineinversetzen kann und ob der sich davon angesprochen fühlt. Ich muss gestehen, so langsam ist dieses Zeitalter etwas weiter weg ;)

Nett fand ich den sehr aktuellen Hinweis, dass Technische Redaktion krisensicher ist, weil sinkende Produktion keine Auswirkung darauf hat, ob Doku geschrieben wird. Geschrieben werden muss sie sowieso. Nun ja, hoffen wir, das ist auch wirklich so. Dokumentation ist sowieso oft das Aschenputtel im Unternehmen (“Komm schon, die paar Texte kannst du doch schnell abtippen. Das kann nicht so lange dauern.”) und wenn dann auch noch gespart werden muss, sicherlich eine der ersten Anlaufstellen. Auf Kosten der Qualität wird da sicherlich hier und da “krisen-gespart”.

Aber dennoch bin ich in Anbetracht dessen, dass der Beruf recht unbekannt ist, immer wieder baff, wie viele offene Stellen es für technische Redakteure in Deutschland gibt. Mir gibt das jedenfalls immer ein wenig selige Sicherheit ;)

Geschrieben in Beruf,Redakteurs Alltag | 2 Kommentare

DITA und XMetal

Und jetzt erst finde ich diese Präsentation von Simon Bate (Scriptorium)! Meine Güte, da hätte ich mir einiges an nerviger Recherche sparen können.

Aber ich will mein Wissen natürlich brav weitergeben: also holt euch Popcorn, was zu schreiben und stellt das Radio aus. Hier wird es wirklich interessant und praxisbezogen :)

Hierbei muss ich erwähnen, dass ich Slideshare einfach großartig finde. Im deutschen Raum scheint es noch gar nicht sehr verbreitet zu sein. Vielleicht sollte man das auch mal den Leuten der tekom zeigen. Es wäre ja viel cooler, die Tagungspräsentationen hier zu posten, als irgendwo in den Irrungen&Wirrungen der tekom-Webseite (die sich nicht gerade durch einen großen information scent hervortut). Und ich glaub auch fast, dass man hier auch mehr Hits erhalten würde.

Geschrieben in DITA,Erweiterter Horizont | Keine Kommentare

Spaß, Spaß… wir wollen Spaß!

Es ist wahr, was man so oft sagt: zwingt man sich erst einmal wieder zum Schreiben, fallen einem schon tausende Sachen ein, die man bloggen will :)

Die Kollegen vom Joomla-Buch haben einen Blogpost zum Thema Humor in der technischen Doku gemacht. Den Ansatz finde ich recht interessant, wobei mir ganz persönlich hier noch gute Beispiele fehlen, um das ganze etwas zu veranschaulichen. Aber dazu muss man wohl den Vortrag der Kollegen auf der tekom-Frühjahrstagung besuchen, was mir nicht vergönnt sein wird, da mich der Rest des Programms nicht sehr anmacht. Aber hey, vielleicht sind sie so multimedial und filmen das ganze und laden es bei youtube hoch ;)

Spaß beim Lesen – culture clash

Ich habe schon relativ viel Fachliteratur auf Englisch gelesen und egal ob es ein englischer Artikel zu Goethe oder Heine war oder Steve Krugs Don’t make me think, ich hatte immer das Gefühl, das das beim Lesen mehr Spaß macht  als ein deutsches Buch. Da ist immer ein Augenzwinkern, eine kleine Anekdote oder ein lockerer Spruch dabei, die einem zum Schmunzeln bringt und dabei die Identifiktation und das Verstehen fördert. Allein eine Buchreihe mit dem Titel “A brain-friendly guide” bringt mich schon zum Lachen :)

Gerade im wissenschaftlichen Bereich scheint es in Deutschland wichtig zu sein im Schriftlichen immer bierernst zu bleiben, weil man sonst eben auch nicht ernst genommen wird. Ich glaube kaum, dass die Amerikaner humorvoller sind als die Deutschen, denn humorvolle Vorträge u.ä. habe ich schon oft erlebt, nur im schriftlichen Bereich ist vieles noch sehr verschnarcht.

Spaß in der Doku?

Leseanreize zu schaffen ist auch für uns Doku-Schreiberlinge wichtig – der Leser soll nicht beim Anblcik schon denken: “Ok, ne. Ne, das les ich nie. Oh, mein Gott!”. Aber mit dem Humor ist es so eine Sache, finde ich. Sehr oft konsultiert der Leser die Doku in einer Stresssituation:

&%/*!$ nochmal! Warum macht das Ding nicht was ich will?! Wo ist die HILFE?

Ich persönlich drehe ab, wenn mir jemand in Stresssituationen schriftlich oder persönlich mit Humor kommt (wem ist schon zum Lachen zumute, wenn Word kurz vor dem Fertigstellen der Doku die Formatvorlagen des 200-Seiten-Dokuments zerschießt?). Daher kann ich mir vorstellen, dass so mancher Leser sich veräppelt vorkommt, wenn man auf die lustige Tour kommt.

Es ist ja auch eine Frage des Produkts, um das es geht: habe ich eine Business-Software, die von eher konservativen Leuten gelesen wird oder eine Messenger-Software bei der die jüngere Clientel den einen oder anderen lockeren Spruch cool findet? Passt der Humor zur restlichen Kundenkommunikation?

Spaß in Beispielen

Mein persönlich einziges Einsatzgebiet von Humor in der Doku sind Beispiele. Hier kann man den Nutzer mit einem kleinen Seitenhieb auf das Alltagsleben abholen, wie etwa hier:

Angenommen Ihr Kollege ist in Urlaub gefahren und hat vergessen das Dokument vorher zum Bearbeiten freizugeben und Sie müssen es nun eigentlich veröffentlichen. In diesem Fall können Sie diese Funktion…

Jedem Büromensch fällt doch dazu gleich eine eigene Anekdote ein, was so der ein oder andere vor dem Urlaub vergessen hat zu tun ;)

Ganz abgesehen davon, dass es einem auch als Schreiberling Spaß macht, solche Beispiele zu erfinden. Hier kann man wirklich kreativ werden und mal vom Sachlichen wegkommen.

Geschrieben in Erweiterter Horizont,Redakteurs Alltag | Keine Kommentare

DITA-Output filtern mit XMetal

Wiederverwendung und Varianten
Das Filtern wird in Zeiten der Wiederverwendung früher oder später notwendig. Man hat beispielsweise ein Produkt, dass es in einer Light-Version und einer Vollversion gibt. Natürlich werden sich hier die Hilfetexte zum größten Teil überschneiden – bis auf die kleinen Ausnahmen, wo dann in der Vollversion hier noch ein Schritt weniger ist und dort eine Option mehr verfügbar. Man hat also eine Wiederverwendungsquote von 90%, aber was tun? Die Hilfetopics nun zweifach vorhalten? Ne, da sträuben sich jedem guten Redakteur die Haare. Redundanz, nein danke!

Nun, wie wär’s, wenn man einfach alle Varianten in eine Datei schreibt und die Teile, die nur für ein Produkt gelten mit einem Attribut versieht? Und dann beim Generieren einen Filter definiert, der nur Teile generiert, die einen bestimmten Attributwert enthalten? Klingt cool – isses auch!

Attribute in DITA
Es gibt für DITA schon einige fest definierte Attribute, die man an fast jeden Tag vergeben kann. Es sind gängigen Attribute nach denen man in der Doku filtert und für die man frei Werte definieren kann:

  • product
  • audience
  • platform
  • outputclass (erst ab DITA OT 1.4 unterstützt)

Zu guter Letzt gibt es das otherprops-Attribut, das so ziemlich alles enthalten kann. Eine Art Auffanglager für den Rest sozusagen.

DITA-Attributvergabe im XMetal

Wir nehmen uns nun ein Beispiel, in dem ein bestimmter Handlungsschritt nur in der Print-Hilfe auftaucht und in der Online-Hilfe nicht, weil die Online-Hilfe kontextbasiert ist und ein Zwischenschritt wegfällt, der aber in der Print-Version nötig ist.

Eigentlich sollte man dazu ab DITA 1.4 das Attribut outputclass verwenden, da ich aber noch auf DITA 1.3 arbeite, werde ich also das otherprops-Attribut verwenden. Ich markiere den <step> und  schreibe im Attribute Inspector einfach den Wert hinein nach dem ich filtern möchte.

Der Nachteil hierbei ist, dass je nach Attributwert einem anderen Redakteur nicht unbedingt von Namen her sofort klar ist, nach was hier gefiltert wird. Wenn ich z.B. handbook als Wert eingebe, kann das einerseits bedeuten, dass ich für den PDF-Output etwas filtern möchte (es also eine technische Bedeutung hat) oder aber für den Dokumenttyp “Handbuch” (was dann eher inhaltliche Bedeutung hat).

Filterregeln in XMetal anlegen

Hierzu muss man folgende Datei öffnen: c:\Programme\XMetaL 5\Author\Conditional Text\configs\ct_config.xml

Hier kann man nun seine Attributwerte definieren und festlegen, wie diese in der Filterauswahl angezeigt werden. Ich habe hier den Attributkomplex zu otherprops bearbeitet. Für jeden Attributwert definiert man einen <value>-Tag, in name steht der Attributwert und in title steht der Anzeigename in der Filterauswahl.

´[....]

Filterregeln auswählen

  1. Auf File > Generate Output from DITA map klicken.
  2. Im Dialog auf Show/Hide Conditional Text klicken.
  3. Hier kann man nun auswählen, welche Filterkriterien für den aktuellen Output gelten sollen.
    Ich will nun beispielsweise eine Online-Hilfe generieren, d.h. der <step>, der nur für Handbücher gilt, soll nicht generiert werden. Also klicke ich das Filterkriterium Onlinehelp an. Es wird alles generiert, was keinen Wert für dieses Attribut hat oder eben genau diesen Wert, d.h. der <step> mit dem Attributwert Handbook wird hier nicht generiert werden.

Ergebnis
Am Anfang steht also dieser Code:

Öffnen Sie das Programm.

Klicken Sie auf

DateiNeu

Editieren Sie die Datei.

Und am Ende dieser Text:

  1. Klicken Sie auf Datei > Neu.
  2. Editieren Sie die Datei.
Geschrieben in DITA | 1 Kommentar

Gelesen: DITA – Der neue Standard für technische Dokumentation

Bisher sind die Informationsquellen bzw. die Literatur zu DITA eher rar, im Endeffekt bleibt man beim User-Guide und der Yahoo-Group hängen und sammelt sich dort alles irgendwie zusammen.

Nun bin ich endlich dazu gekommen mir das erste deutschsprachige Buch rund um DITA zu bestellen und zu lesen: DITA – Der neue Standard für technische Dokumentation von Johannes Hentrich. Frau Closs Buch konzentriert sich ja mehr auf Topicorientierung als auf DITA, auch wenn das natürlich gut zusammenpasst.

Was steht zu DITA drin?

Es ist so ziemlich alles drin, was man über DITA wissen muss:

  • Welche Philosophie dahinter steht,
  • wie es funktioniert,
  • was das Open Toolkit ist,
  • wie man den Output, also die Stylesheets, verändert,
  • wie man mit DITA wiederverwendet und filtert,
  • welche Editoren es gibt,
  • warum ein CMS Sinn macht…

Sehr gut fand ich die Anwendungsbeispiele. Erst hier hab ich mal so richtig kapiert, was chunking eigentlich bedeutet (und das werde ich hier sicherlich mal noch in eigenen Worten wiedergeben). Ein bisschen überflüssig fand ich, dass sehr viele Dinge wiederholt wurden, z.B. was Topicorientierung bedeutet…

Unnötige Basics

So gut ich den Umfang zu DITA fand, so schlecht fand ich, dass das Buch gleichzeitig noch versucht einen Rundumschlag in Sachen “Technische Redaktion” zu machen. Das macht das Buch ein bisschen unausgewogen in seiner Zielsetzung. Und mal ganz ehrlich – wenn man sich in DITA reinkniet und bereit ist Stylesheets u.ä. anzufassen, dann muss man hier nicht bei den Binsenweisheiten der TDOKU anfangen. Ja, ich weiß, dass Standardisierung wichtig ist und Wiederverwendung sowieso. Wer es nicht weiß, hat den falschen Beruf gewählt oder sollte erst einmal bei den echten Basics-Büchern anfangen.

Rechtschreibprüfung?

Was mein Redakteusenauge sehr genervt hat, waren die zahlreichen Tippfehler und auch Satzfehler in dem Buch. Mindestens alle drei Seiten war irgendetwas falsch geschrieben oder umgebrochen. Für das nächste Buch empfehle ich hier einen sorgfältigeren Lektor. Bei so einer kritischen Zielgruppe MUSS da alles stimmen.

Fazit

Für Leute, die sich in DITA reinknien wollen, ist das Buch auf jeden Fall das Richtige. Die unnötigen Kapitel kann man ja zum Glück einfach überspringen ;) Ansonsten bekommt man alle Infos, insbesondere auch die zum Toolkit kompakt und gut dargestellt und erklärt. Dieser Teil hat mich persönlich sehr überzeugt.

Für Anfänger in der technischen Doku hingehen enpfehle ich das Buch eher nicht, da die Kapitel, die richtig in die DITA-Materie reingehen, hier meiner Meinung nach eher abschrecken / überfordern.

Zum Abschluss muss ich noch erwähnen, dass ich die Behauptung, dass gute Stichwortverzeichnisse bei Büchern kaufentscheidend sind, sehr witzig fand. Das trifft bei mir allerhöchstens auf Lexika und Telefonbücher zu ;) Ansonsten ist in der Regel sicherlich das Inhaltsverzeichnis der ausschlaggebendere Punkt, nicht umsonst stellt amazon bei vielen Büchern das Inhaltsverzeichnis online zur Verfügung. Keine Frage Indizes sind ein wichtiges Navigationsmittel, aber meist bemerke ich die erst weit nach dem Kauf.Umso lustiger fand ich es aber mir auf diese Aussage hin mal den Index dieses Buchs anzuschauen und etwas darin zu suchen. Es sei nur soviel gesagt: Er sollte nicht eure Kaufentscheidung beeinflussen. Denn eigentlich lohnt sich das Buch :)

Geschrieben in DITA,Erweiterter Horizont,Nice to know | Keine Kommentare