Die Redakteuse

Kategorie: Allgemein

  • Und jetzt?

    So, es sind also nur locker-flockige 2,5 Jahre seit dem letzten Blogpost vergangen. Ich schiebe das Blog-Thema ja schon so eine Weile vor mir her. Soll ich es archivieren? Wie fange ich wieder an? Über was blogge ich? Nach 1 Jahr Elternzeit müssen sich die Synapsen ja auch erst einmal wieder auf das Thema Redaktion & Co. einstellen. Und mit einem Mama-Blog verschone ich euch mal 😉

    Und bevor ich anfange einen Redaktionsplan zu erstellen und sonst irgendwelche tollen Masterpläne, sag ich einfach mal: Da bin ich wieder. Und ich werde wieder öfter da sein 🙂

     

     

  • Redakteuse live – tekom Jahrestagung 2012

    Die tekom-Jahrestagung in Wiesbaden rückt näher und selbstverständlich bin ich wieder dabei. Auch in diesem Jahr gibt es einen großen Track zum Thema „Content Strategy“, der wieder mit einer Vielzahl an interessanten Vorträgen lockt. Aber auch ansonsten klingt das Programm sehr vielversprechend und daher wird es wieder wie immer schwer sich zu entscheiden, in welchen Vortrag man letztlich geht.

    Ganz besonders würde ich mich freuen, wenn der eine oder andere sich für einen meiner Vorträge entscheidet 🙂

    Mit DITA um die Welt
    Hier erfahrt ihr alles, was ihr wissen müsst, um eure DITA-basierte Dokumentation fit für die Welt zu machen.

    The strategic technical communicator
    In diesem englischsprachigen Panel sprechen Nicky Bleiel, Sarah O’Keefe, Tony Self und ich über berufliche Strategien für Technische Redakteure. Dabei werde ich vor allem über Strategien für angehende Freiberufler sprechen – ein Thema, das bei mir ja noch relativ frisch ist.

    PS: Am Dienstagabend gibt es im Foyer eine kleine Welcome Party von Atlassian und k15t Software, die nun auch als Location für ein TR/techcomm-Tweet-up dient. Man sieht sich spätestens dort 🙂

  • Redakteuse live „DITA – Grundlagen und Tipps für Einsteiger“

    Im Rahmen der Abendveranstaltungen der tekom-Regionalgruppe Baden halte ich am 23.02. in Karlsruhe einen kleinen Vortrag zu meinem Lieblingsthema 🙂

    Für alle DITA-Interessierten mit Grundkenntnissen in XML und Standardisierung gibt es einen kleinen Rundblick mit folgenden Punkten:

    * Was ist DITA?

    * Für welche Einsatzzwecke ist DITA geeignet?

    * Was sind die Vor- und Nachteile?

    * Was kann man alles mit DITA anstellen?

    * Wie steigt man am besten in die DITA-Welt ein?

    Weitere Informationen zu Anmeldung und Ort finden sich direkt auf der Webseite der Regionalgruppe. Ich freue mich über zahlreiche Zuhörer 😉

    EDIT: Hier ein Bericht zum Termin 🙂

  • Breadcrumbs in DITA-XHTML – Update

    Ich habe das Breadcrumbs-Plugin ja bereits vorgestellt. Der damalige Bug bei der Verwendung von Reltables war sehr schnell behoben – superklasse!

    Aber schon damals ist mir eine unschöne Sache aufgefallen: der Text für das Wurzelelement in der Breadcrumb ist hart kodiert. Das ist natürlich gerade bei der Internationalisierung der Hilfe eher so ein bisschen doof. Schließlich will ich ja nicht für jedes Generieren jeder Sprache immer wieder die Stylesheets anfassen. Daher hab ich eine Internationalisierung an dieser Stelle eingebaut, d.h. der Text für das Wurzelelement wird je nach Sprache der Map & Topics generiert.

    Wer sich dafür interessiert, befolge bitte diese Schritte:
    In der Datei dita.xsl.maplink.xsl aus dem Plugin wird dieser Schnipsel
    <xsl:param name="indexLinkText" select="'Index'"/>>

    zu diesem


    <xsl:param name="indexLinkText">
    <xsl:call-template name="getString">
    <xsl:with-param name="stringName" select="'Start'"/>
    </xsl:call-template>
    </xsl:param>

    In der de-de.xml im xsl-Verzeichnis des Toolkits muss natürlich der entsprechende String angelegt werden:
    <str name="Start">Start

    Dann muss man noch den obigen Schnipsel aus Zeile 9 in das xsl-Template (ab Zeile 14) verschieben, also so:

    <xsl:template match="*" mode="link-to-other">
    <xsl:param name="pathBackToMapDirectory"/>
    <xsl:param name="indexLinkText">
    <xsl:call-template name="getString">
    <xsl:with-param name="stringName" select="'Start'"/>
    </xsl:call-template>
    </xsl:param>
    <xsl:if test="$doAncestors='yes'"> ......

    Wenn man die Parameterdefinition global belässt, wird immer nur en-us als Sprache erkannt, warum auch immer.

    So, das war's auch schon. Und zu meinen Tricks, um mich beim Programmieren und Testen bei Laune zu halten, gehören motivierende Ausgabetexte für den Fall, dass es endlich klappt, und eher so die destruktiven für den anderen Fall 😉

  • tekom-Jahrestagung 2009 #2 – Embedded help

    So, ich versuche mal einige Vorträge derselben Themengebiete zusammenzufassen:

    Nicoletta Bleiel, ComponentOne – Improving Software Usability with Embedded User Assistance

    Ich hatte Nickys Vortrag aus dem letzten Jahr noch gut im Gedächtnis und da auch das Thema passte, bin ich also nichts wie hin.

    Hauptthema war Hilfe, die in die Software eingebettet ist und sich nicht außerhalb des Nutzungskontexts befindet. Damit soll gewährlkeistet werden, dass man den Nutzer nicht aus seinem Workflow reißt, indem man ihn dazu zwingt erst einmal die Hilfe zu öffnen, zu suchen, die „richtige“ Frage zu stellen etc. Embedded help wird oftmals gar nicht als „Hilfe“ empfunden.

    Nicky zeigte uns hier ihre Umsetzung davon bei der Hilfe von Doc-to-help.

    Das Besondere hier war ein bestimmtes Modul, das es dem Redakteur ermöglicht sehr einfach einen Bezug zwischen einem GUI-Element und einem Hilfetext herzustellen – direkt am Interface und nicht über die Verwaltung von irgendwelchen GUI-Element-IDs. Sprich: der Redakteur markiert ein GUI-Element (Button / Menüpunkt etc) , öffnet einen bestimmten Hilfetext in der Applikation und stellt so einen Bezug zwischen den beiden her. Wenn also der Nutzer das entsprechende GUI-Element anklickt o.ä., kommt direkt der dazu passende Hilfetext.

    Leider ist das Modul nur in .NET-Applikationen verfügbar. Ich finde diese visuelle Unterstützung für das Mapping äußerst attraktiv (nicht zuletzt, weil ich mich bald mit diesem Thema beschäftigen werde und da wohl eher die Lösung mit GUI-IDs übrig bleiben wird).

    Im restlichen Teil des Vortrags hat Nicky ihre Vorgehensweise dargestellt – von der Konzeption bis zur Umsetzung verriet sie Tipps und Tricks, u.a.:

    • keine Sackgassen-Topics, d.h. jedes Topics sollte verwandte Topics verlinken, und wenn es nur die Verlinkung von Eltern-Kind-beziehungen ist.
    • Trotz kontextbasierter Hilfe bei der Erklärung von Funktionen immer auch erwähnen, wie man eine Funktion findet. Ein Nutzer liest den Hilfetext evtl. nicht im Kontext und weiß gar nicht, wie er die Funktion erreichen kann.

    Weitere Details könnt ihr auch inNickys entsprechendem Artikel auf der tcworld nachlesen.

    User Assistance 2.0 – Produktinformation als Mittel für Kundenbindung und Kundenmehrwert

    Anfangs wurde hier die These aufgestellt, dass Serviceangebote, eben auch umfassende Hilfeangebote, zukünftig immer wichtiger werden. Irgendwann hat jede Produkt-Featuritis ein Ende: man kann einfach nichts mehr Sinnvolles dazubauen. Und dann fängt man eben mit Dienstleistungen an.

    Hier hat t3 eine ganzheitliche Informationslösung zusammengestellt, die ich persönlich ziemlich cool fand. Angefangen von embedded help, die sich konkret auf aktuelle Aufgaben bezieht, hin zu einer  dynamischen Hilfe, die mehr prozessorientiert und wissensvertiefend angelegt ist. Am Ende steht ein Wissensportal, das sowohl prozess- und aufgabenorientiert augebaut ist als auch produkt- und themenorientiert. Durch das Portal hat man auch einen Feedbackkanal und gibt den Nutzern auch die Möglichkeit eigene Tipps & Tricks und sogar Dateien austauschen können.

    Diese „mehrstufige Vernetzung“ hat mir sehr gut gefallen. Jeder Mensch verhält sich ein bisschen anders bei der Informationssuche und dieses Konzept deckt für mich ein großes Spektrum ab.

    Software und Dokumentation – Mit XML zusammenfügen, was zusammengehört

    Hier wurde eine sehr spezifische Lösung präsentiert, wie ein Hilfetext in die Software-Oberfläche gelangen kann. Die hier eingebettete Hilfe war jedoch relativ statisch ohne Navigations- oder Suchmöglichkeiten und auch optisch eher „nüchtern“ – das ist sicher noch ausbaufähig. Es wurde vor allem auf den Prozess eingegangen, d.h. wie der Austausch zwischen Redaktionssystem und Software funktioniert.  Ich glaube mich noch zu erinnern, dass ich das ganze etwas frickelig fand – spätestens bei der Excel-Tabelle, die für bestimmte Workarounds nötig ist, war ich etwas entsetzt (aber wer hat sie nicht, die kleinen ekligen Workaorunds, die man lieber nicht weitererzählt….).

    Das Endergebnis ist ein rudimentäres Beispiel von embedded help und höchstens dahingehen interessant, wie das Zusammenspiel zwischen Doku und Entwicklung funktionieren kann.

  • tekom-Tagung 2009 – Countdown

    Pünktlich zum Highlight des TR-Jahres erwache ich wieder aus dem Blog-Koma 🙂

    Eiiigentlich gäbe es zur Zeit viel zu bloggen, doch ist es mir in den letzten Wochen schwer gefallen auch wirklich etwas zu schreiben. Manchmal muss man abends auch ein bisschen Abstand zum Beruf gewinnen – man nennt es auch Freizeit 😉

    In Anbetracht der bevorstehenden Informationsaufnahme mache ich mich aber nun langsam warm.

    Ich werde am Mi. und Do. die Tagung besuchen und freue mich riesig. Mein persönlicher Fokus liegt dieses Jahr auf den Themen:

    • Lokalisierung / Übersetzungsmanagement
    • User assistance
    • Redaktionssystem / Metadaten

    Ich hoffe, da draußen findet sich dann noch der ein oder andere Blogger, der den Tagungs-Freitag „verarbeiten“ wird 🙂

  • Links in DITA #3 – Relationship tables

    Mit den so genannten Relationship tables (reltable) kann man die Beziehungen zwischen Topics definieren. Hiermit implementiert man Verlinkungen, die nicht durch die Hierarchie (oder die anderen collection-types) festgelegt ist. (mehr …)

  • Links in DITA #2 – Hierarchien und collection-type

    Ich habe bereits vorgestellt, welche Möglichkeiten des manuellen Verlinkens es gibt. Wie gesagt, erschwert diese Methodik die Wiederverwendung eines Texts. Da Wiederverwendung jedoch einer der Kernpunkte von DITA ist, gibt es natürlich auch hier Mittel und Wege. Und zwar indem man die Verlinkungregeln in die Maps auslagert. So kann man auch nur das verlinken, was in der Map drin ist und läuft nicht Gefahr tote Links zu erzeigen.
    (mehr …)

  • XHTML-Output anpassen

    Jeder, der mit DITA anfängt, kommt schnell an dem Punkt an dem er das starke Bedürfnis hat, den Output an das eigene Layout anzupassen. Die Standardlayouts im OT sind, sagen wir mal, sehr nüchtern oder auch eher 0.5 als 2.0 😉

    Und in einer Firma will man natürlich Logos und allerlei Schnick-schnack einbauen.

    So, und ich will nun beginnen einen schönen XHTML-Output zu bauen und habe nun damit angefangen die XSL-Stylesheets auseinanderzunehmen, um zu verstehen, was eigentlich wo passiert.

    Schöne Overrides

    Sehr interessant fand ich diese schöne modulare (oh ja, das Wort das jeden technischen Redakteur jauchzen lässt!) Vorgehensweise die eigenen Anforderungen einzubinden. Robert Anderson zeigt in diesem Webinar, dass man eigene Anpassungen immer auslagern sollte, seien es eigene Spezialisierungen oder eben auch „nur“ eigene Layoutdefinitionen. So muss man beispielsweise später keine Bedenken haben, wenn man ein Upgrade auf eine neue OT-Version machen möchte: man hat eben keine Original-OT-Dateien bearbeitet, sondern nur eigene, die in die OT-Dateien nur eingebunden werden.

    Das OT bietet dem User die Möglichkeit sogenannte Overrrides zu definieren, die die Standard-Einstellungen mit den selbst definierten überschreiben.  Diese Overrides werden in Plugins ausgelagert. In der Datei _dita2htmlImpl.xsl_ sind dafür ab Zeile 4166 Templates vorgesehen und zwar für Header, Footer, die head-section,Angaben zu CSS-Dateien und Skripten.

    Eine sehr einleuchtende Vorgehensweise, die schön modular und damit leichter pflegbar ist.

    Ich benutze ja XMetal und hier wurde eine solches Layoutmodul schon mitgeliefert. Wer einmal den Output Single HTML file advanced testet, wird sehen, dass da ein JustSystems-Design hinterlegt ist. Die entsprechenden Dateien findet man je nach Installation ungefähr hier: c:\Programme\Gemeinsame Dateien\XMetaL Shared\DITA_OT\demo\xhtmls.

    Hässliche Overrides

    Umso seltsamer fand ich, dass für einfache Anpassungen im OT-User-Guide ein ganz anderes Vorgehen geschildert wurde: einfach das XSL aus dem OT kopieren, entsprechend ändern und unter anderem Namen abspeichern. Und dann den Output über dieses eigene Stylesheet erzeugen (Quelle). Nun ja, klar das geht. Aber irgendwann wird es nahezu unmöglich sein herauszufinden, was Original-OT ist und was man selbst verbrochen hat. Und Updates sind dann sehr aufwändig.

    Schön oder hässlich? – Kommt drauf an

    So wie ich das bisher verstehe, ist „hässliche“ Variante erst sinnvoll, wenn ich den XHTML-Output komplett anders haben möchte. Dann verbiegt man sich komplett, indem man alle Änderungen in Overrides auslagert. Ich habe beim TWiki genau diese Erfahrung nämlich gemacht. Man kann dort die Default-Styles mit eigenen Styles überschreiben und den Rest übernehmen. Bei einem Update haben die selbstdefinierten Styles damals nicht mehr gut funktioniert, weil man sich in zu vielen Punkten auf Default-Styles verlassen hat und die aber beim Update signifikant verändert wurden.

    Los geht’s

    Bei mir wird leider nicht bei einigen „billigen“ Styleverbesserungen bleiben, sondern ich will strukturell auch einiges anders haben als im Standard-Output und daher versuche ich mal es in einem neuen Stylesheet auszulagern. Es wird spannend 🙂

  • Logfiles in XMetal – Nachtrag

    Einen kleinen Haken hat die Angelegenheit!

    Man sollte nicht aus Versehen das Verzeichnis löschen, das man als Logfile-Verzeichnis angegeben hat. Sonst bekommt man nämlich diese vielsagende Fehlermeldung beim Generieren!


    Tja, ich wusste durch diese Meldung zwar, dass irgendetwas nicht gefunden wurde, aber was?! Nachdem ich mir anschaute, welche Verzeichnisse ich kurz vorher „aufgeräumt“ hatte, wusste ich Bescheid…

    Wer also bei XMetal eine Fehlermeldung zur DitaRenditionsImpl bekommt und gar mit dem Error code -2,146828212, landet hoffentlich auf dieser Seite und erlangt die Erleuchtung. Meine Suche danach hat nämlich nichts ergeben 😉