In meinem Hauptprojekt arbeitet mein Redaktionsteam seit neuestem mit OTRS als Ticket-System.

Warum tun wir das?

  • Wir haben einen großen Arbeitsanteil an Support der Editoren unseres Confluence-Systems, damit ist ein solches Ticket-System sinnvoll.
  • Das Redaktionsteam ist gewachsen und Tasks werden stärker verteilt. Mit OTRS wird klarer, wer was tut bzw. in der Pipeline hat.
  • Unsere User können an ein zentrales Postfach mailen und damit ein Ticket im OTRS erzeugen, das sich dann idealerweise selbst verteilt.
  • OTRS wurde eigentlich primär für eine Hotline eingeführt, soll aber zukünftig als Service auch anderen Gruppen zur Verfügung stehen. Da wir die Inhouse-Dokumentation von OTRS unterstützen, ist es sinnvoll, auch selbst damit zu arbeiten.

(Mögliche) Nachteile der OTRS-Nutzung:

  • Es ist besser sichtbar, wieviele und was für Anfragen ein Team bearbeitet. Das möchte vielleicht nicht jedes Team.
  • Es ist nicht möglich, Tickets auf regelmäßige Wiederholung zu stellen (z.B. “alle vier Wochen Auswertung X”). OTRS ist auf Durchfluß optimiert, nicht auf Dauerpflege und langfristige Aufgaben. Solche Informationen haben wir daher im Confluence belassen.
  • Auch bei Verwendung von OTRS muss man als Redaktionsleitung regelmäßig prüfen, dass keine Tickets durchs Raster fallen und unbeantwortet bleiben.
  • Neue Prozesse müssen definiert und mit dem Team etabliert werden. Dies verursacht etwas organisatorischen Aufwand.
  • Unsere User müssen sich daran gewöhnen, statt direktem persönlichem Kontakt zumindest im Mail-Header mit OTRS die Mails auszutauschen. Manche interpretieren dies dahingehend, dass unserem Team das OTRS “übergestülpt” wurde – was nicht der Fall ist. Hier hilft nur Aufklären im Gespräch.

Bisher überwiegen die Vorteile für uns – und davon abgesehen ist es für Redakteure im Bereich der Softwaredokumentation gut, auch einmal mit Ticketing-Systemen zu arbeiten, da diese in Support und Entwicklung sehr häufig sind.

Für andere Redaktionsteams würde ich eine Empfehlung von OTRS daran festmachen, wie hoch der Supportanteil in der Arbeit ist. Für Verteilung von Dokumentations-Arbeitspaketen ist es aus meiner Sicht weniger sinnvoll, hier sollten eher klassische Projektmanagement-Werkzeuge eingesetzt werden.

Share
 

Zwei Lesetipps für das aktuelle Heft 3/12 der technischen kommunikation(*):

  • Praxistipps Word: Regelgerechtes Ersetzen auf S. 37 beschäftigt sich mit Regular Expressions aka Mustervergleich in der Word-Funktion Suchen und Ersetzen, der sich hinter dem Schalter “Platzhalter verwenden” versteckt.
  • Rechtschreibhilfen im Vergleich auf S. 45 bietet einen guten, wenn auch schmerzhaften Einblick in die Situation der Rechtschreibung in Deutschland, besonders auf die vielen gängigen/nicht gängigen//erlaubten/nicht erlaubten Variationen. Mein Bauchgefühl, dass das mit der Rechtschreibung immer weicher und dadurch definitiv auch schwammiger wird, wird hier voll bestätigt. Der Duden verliert dabei bei mir etwas – die Rechtschreibungsvorschläge von Wahrig und dpa gefallen mir tendenziell besser. Der Verlierer allerortens ist die Konsistenz; es ist schwierig genug, firmenspezifische Terminologie konsistent zu halten – wenn man dies auch noch mit dem “normalem Deutsch” machen muss, bläht es den hausinterne Redaktionsleitfaden (so vorhanden) reichlich auf.

“technische kommunikation” ist die Verbandszeitschrift der tekom e.V., dem deutsche Fachverband für Technische Kommunikation und Informationsentwicklung.

Share
 

Es gibt sicherlich sehr viele bessere Lösungen, aber manchmal sitzt man mit einem IE und einem Office-Paket da und braucht gaaanz schnell die Farbe eines Textes… und da habe ich heute dazugelernt, wie das auch gehen kann.

  1. Den zu analysierenden Text der Webseite nach Word kopieren (sowohl in Version 2003 als auch 2010 getestet).
  2. Auf ein Wort darin klicken, z.B. den blauen Link.
  3. Neben dem Button “Schriftfarbe” auf den Pfeil klicken und die Option “Weitere Farben” wählen. Farbwerte von Webtexten auslesen mit Word 1
  4. Im Farben-Fenster auf die Registerkarte “Benutzerdefiniert” klicken. Dort finden sich dann die RGB-Farben des Textes.
    Farbwerte für Webtexte mit Word auslesen
  5. Dies kann man dann in eine webtaugliche Farbe übersetzen, beispielsweise auf http://html-color-codes.info/.

Wie gesagt – keine schöne Methode, aber sie funktioniert schnell und mit typischen Großfirmenbordmitteln :)

Share
 

Ein häufiges Problem, wenn man manuell Word-Texte in ein taugliches HTML bringen will: Wie bekommt man am schnellsten z.B. kursive Formatierungen umgesetzt?

Der Trick heißt Ersetzen mit Wildcard.

  1. In Word über Bearbeiten > Ersetzen (STRG+H) den entsprechenden Dialog öffnen.
  2. Mit dem Cursor im Feld “Suchen nach” auf “Erweitern” klicken und über “Format” das Zeichenformat “kursiv” wählen.
  3. Dann im Feld “Ersetzen durch” <i>^&</i> eingeben.
  4. Auf “Alle ersetzen” klicken. Alle kursiv formatierten Texten werden als italic getaggt.

Dies geht natürlich auch für bold oder underlined.

Share
Jul 202009
 

“Two hours of trial and error can save ten minutes of manual reading.”

Share
 

Betrifft mich aktuell nicht, aber auch ich habe schon “fictitious documentation” verfasst:

Fictitious documentation refers to documentation that fails a lie detector test but which passes the project manager’s approval. (zum Artikel)

Idealerweise entspricht die Dokumentation dem Ist-Stand; realistischerweise ist regelmäßig ein Soll-Stand abgebildet, da z.B. nur eine unvollständige Software-Vorversion verfügbar ist. Auch das Verschweigen bestimmter Eigenschaften (besonders solcher, die potentiell Benutzer verärgern) ist nicht selten.

Der zitierte Artikel bezieht sich primär auf echte Bugs und die Frage, ob diese beschrieben werden sollen. Hier findet sich eine Stärke von Open-Source-Systemen – da für diese niemand Geld zahlt, ist es üblich, z.B. bei Modulen ausführlich zu warnen, wenn bestimmte Einschränkungen vorhanden sind. Bei Kaufsoftware dagegen, die zumindest scheinbar einen stabilen, geprüften, fehlerfreien Stand liefern soll, werden Bugs lieber nicht erwähnt, wenn es sich vermeiden lässt…

Share
Apr 052009
 

…können sich ausgiebig Gedanken darüber machen, wie man am besten Smilies in Klammern schreibt:
Emoticons and Parentheses.

Share
Mrz 162009
 

Dilbert.com

Share
 

Eine Bekannte war ein wenig künstlerisch tätig, und das kam dabei raus… “Tools for Technical Writing” by AnK (draufklicken fürs Original):

Mein persönlicher Favorit ist ja das Bugfixing-Verfolgen mit den Tarotkarten…aber das bin ich in der Softwareentwicklung nicht anders gewohnt ;)

Share
Feb 082009
 

Genial: jetzt gibt es ein DITA to WordPress Import Tool ! Was für ein potentiell riesengroßer Schritt für das Thema Online-Hilfe, wenn diese jetzt endlich auch interaktiver und dynamischer werden kann (Medieneinbindung, Kommentarfunktionen etcpp).

Eine Besprechung und ein Demo-Filmchen dazu gibt es hier: Merging Worlds: DITA and WordPress.

Tolle Sache. Ich bin gespannt, wann die ersten Hilfe-Projekte mit dieser Methode online gehen.

Share
© 2012 Doku-Hotline Suffusion theme by Sayontan Sinha