Archiv des Autors: Michael Müller-Hillebrand
TCS Sprechstunde
Neulich erst schrieb ich leicht erstaunt und durchaus erfreut in Neue Offenheit über die Aktivitäten von Adobe in FrameMaker-Entwickler-Foren.
Heute wird das getoppt von der Ankündigung eines »Monthly Online Community Gathering« unter dem Titel Ask the Adobe Technical Communication Team. An jedem dritten Donnerstag im MontagMonat um 8:30 PST (zur Zeit 17:30 MESZ) soll es eine Art Sprechstunde geben, rund um die Technical Communication Suite. Es soll keine Registrierung nötig sein, natürlich wird das in Englisch stattfinden, aber das Engagement aus Indien (dort ist es dann immerhin 21:00!) ist doch toll. Erster Termin: 18.8.2011, 17:30h
Natürlich geht es Adobe auch darum, zu hören, welche Wünsche die Anwender so haben, um die Produkte so weiter zu entwickeln, dass möglichst viele Updates gekauft werden. Aber wenn sich das Produkt dabei verbessert, warum nicht?
Veröffentlicht unter FrameMaker, RoboHelp
3 Kommentare
Diversifizierter Stil oder saubere Terminologie?
Diversifizierter Stil oder Vereinheitlichter Stil – eine Vereinheitlichung der Schreibweise in Handbüchern ist in jedem Fall nötig, nicht nur damit für den Leser Gleiches immer gleich benannt wird, sondern auch um in Sachen Terminologie wenigstens kleine Schritte vorwärts zu machen. Nicht nur in Vorträgen wird der Nutzen einer durchgängigen Terminologie gepriesen, in vielen Fällen wäre diese auch einen Voraussetzung für den effizienten Einsatz von Redaktionssystemen, wenn nicht, ja, wenn deren Entwicklung und Pflege nicht extra Geld kosten würde…
Umso dankbarer sollten wir für die Terminologieempfehlungen von Marc Achtelig in der aktuellen Ausgabe 04/11 der Zeitschrift Technische Kommunikation (ab S. 40) sein, der uns viele Formulierungsmuster an die Hand gibt und auf Fallstricke hinweist. Meine Lieblinge sind:
- Sichern ist Backup, in der Regel wollen wir speichern!
- »ausgegraute« Elemente sind nicht deaktiviert, sondern nicht verfügbar (in Programmierersprache: disabled)
Ach ja, ich bevorzuge den vereinheitlichten Stil und dort die super-verkürzte Form, denn in »Klicken Sie auf Datei > Drucken« scheint mir auch das Wörtchen »auf« entbehrlich zu sein: »Klicken Sie Kommentar abschicken!
Der Artikel ist auch auf der Webseite der tekom verfügbar: »Wählen, aktivieren oder klicken?«
Veröffentlicht unter Sonstiges, tekom/tcworld
5 Kommentare
Schwere Rechtschreibung
Ulli’s Imbiss
Blumen Paradie’s
Bahnhof’s Gaststätte
Bei diesem Anblick denkt man manchmal, der Umgang mit dem Apostroph sei ein spezifisch deutsches Problem – weit gefehlt! Und da es viel schöner ist, sich über die Schwierigkeiten in anderen Sprachen zu amüsieren, als zugeben zu müssen in der eigenen Muttersprache eventuell nicht 100-%ig sattelfest zu sein, finden Sie auf theoatmeal.com eine Sammlung illustrierter Ratgeber zu:
- How to use an apostrophe
- How to use a semicolon
- Ten words you need to stop misspelling
- When to use i.e. in a sentence instead of e.g.
Amüsant und zudem hilfreich für jeden, der auch in Englisch korrekt schreiben will. Einen kleinen Test dazu gibt es auch: Spelling Test Quiz.
Und damit ab in den Sommer!
PS: Weitere hilfreiche Tipps sind How to fix any computer oder noch wichtiger Why It’s Better To Pretend You Don’t Know Anything About Computers.
PPS: Beim Spelling Test hatte ich – tada! – 100%:
Veröffentlicht unter Sonstiges
Kommentare deaktiviert für Schwere Rechtschreibung
Attribut-basiertes Filtern
Mit FrameMaker 10 hat Adobe bei dieser Funktion in zweierlei Hinsicht nachgebessert:
- Sie können gewählte Einstellungen über den Format-Import in andere Dateien importieren
- Sie können nun auch Attribute mit mehreren Werten auswerten
Das letzte will ich kurz erläutern. Aus Ihrer Master-Dokumentation sollen zum Beispiel Handbücher für drei Produktvarianten A, B und C entstehen. Dann gibt es zwangsläufig Texte, die allgemein gültig sind, einige sind speziell nur für eine Variante (A, B, C), andere wiederum für zwei der drei Varianten (AB, BC, AC). Bislang mussten Sie die möglichen Kombinationen ausmultiplizieren, um all diese Fälle abdecken zu können. Jetzt gibt es neue Operatoren, mit denen neben dem Fall Attribut enthält den Wert auch Attribut enthält irgendeinen Wert (ANY) und Attribut enthält nur bestimmte Werte abgefragt werden können. Die Detail finden sich in folgendem Blog-Beitrag:
Ein wenig rätsele ich, weshalb Adobe sich innerhalb der inkonsistent umgesetzten Boole’schen Algebra dann noch einmal eine eigene Syntax mit dem Operator # ausgedacht hat. Denn es gibt bereits einen Standard, mit dem man sogar viel mehr machen kann, als Attributwerte abzufragen: XPath. Und XPath-basierende Ausdrücke können Sie mit dem nach wie vor kostenlosen Plug-in AXCM verwenden (welches auch sonst deutlich flexibler ist):
| Adobe FBA¹ | AXCM Ausdruck |
|---|---|
| platform = „win“ | *[@platform = „win“] |
| platform #ANY | *[@platform != „“] |
| platform # „win“ „unix“ | *[contains(„win unix“, @platform) or contains(„unix win“, @platform)] |
Der dritte Fall sieht zwar in XPath komplizierter aus, aber wenn Sie sich einmal an die Logik gewöhnt haben – die Sie auch in anderen XML-basierten Umgebungen brauchen können! – werden Sie feststellen, dass die Mächtigkeit von XPath diesen Extra-Aufwand ohne weiteres wert ist. Weitere Informationen zu AXCM finden Sie hier:
¹: FBA = Filter By Attribute
Veröffentlicht unter FrameMaker
Kommentare deaktiviert für Attribut-basiertes Filtern
FrameMaker 10.0.1
Bei FrameMaker 9 war nach zwei Monaten das erste Patch-Release verfügbar, jetzt ist es auch bei FrameMaker 10 so weit. Fünf Monate sind seit dem Release vergangen und aus 10.0.0.388 wird 10.0.1.402.
Zu den addressierten Themen gehören (eine subjektive Auswahl):
- Print to PDF command now ask PDF destination even for 64 bit machines.
- FrameMaker 10 used to crash on performing spell-check on files having unicode quotation marks i.e. U+2018, U+2019, U+201C, ,U+201D in user dictionary. This has been now fixed.
- Earlier fonts that contain CJK character sets were not showing correct hyphenation for certain words. This has been fixed now.
- FrameMaker 10 used to crash on using Ctrl+F4 to close Book files. This has been fixed.
- FrameMaker was unable to save book, containing files with SVG reference, to XML. This has been fixed.
- Some ExtendScript API’s in FrameMaker had memory leaks. This has been fixed.
- ExtendScript’s „ObjectValid()“ function returned false for each table when we get a list of tables using GetText(). This has been fixed.
- ExtendScript sample „BookMIFWash“ had some errors. This has been fixed.
Veröffentlicht unter ExtendScript, FrameMaker
Ein Kommentar
Neue Offenheit!
Es ist kein Fragezeichen in der Überschrift! In diversen Foren sind seit einiger Zeit verstärkt Adobe-Mitarbeiter aus dem FrameMaker-Team präsent, eine durchweg begrüßenswerte Sache. Richtig essentiell ist dies im seit 2004 bestehenden Entwickler-Forum frame_dev, wo Fragen rund um die FDK-Programmierung diskutiert werden.
Auch in den offiziellen Adobe-Foren gibt es immer wieder Beiträge aus Indien.
In Folge der Einführung von ExtendScript mit FrameMaker 10 ist nun auch ein Forum FrameMaker Scripting genau für dieses Thema eingerichtet worden. Was aber leider noch nichts daran ändert, dass eine vernünftige und vollständige Dokumentation dieser Programmierschnittstelle noch überfällig ist. Oh, jetzt habe ich Wasser in den Wein gekippt…
Veröffentlicht unter ExtendScript, FrameMaker
2 Kommentare
Neulich, im Internet: Querverweis-Missbrauch
Ein Service der Comet Computer GmbH aus München ist die Webseite http://www.doku.info/ und dort stieß ich neulich auf den von Robert Hinesley (Technikredakteur bei Comet Computer) verfassten Artikel »Adobe FrameMaker – Begriffslisten zentral verwalten«.
Kurz gesagt wird dort die Verwendung von Querverweisen für die Referenzierung standardisierter Begriffe aus einer zentralen Datei empfohlen:
Häufig verwendete und kontinuierlich gepflegte Begriffslisten können Sie in zentralen Dateien speichern, um sie in Ihren Dokumenten mittels Querverweisen wiederzuverwenden.
Aber das ist so gestern! Weiterlesen
Veröffentlicht unter FrameMaker
Kommentare deaktiviert für Neulich, im Internet: Querverweis-Missbrauch
Menschen bitte nicht in die Waschmaschine tun
(via tagesschau.de)
Dass es sich bei seltsamen Warnmeldungen im Land der unbegrenzten Möglichkeiten nicht nur um Legenden und Gerüchte handelt, zeigt uns der alljährliche Wettbewerb um den seltsamen Warnhinweis. Aktuell wurden die Finalisten der Wacky Warning Labels™ vorgestellt:
Viel Spaß mit diesen Wirklich Wichtigen Warnmeldungen!
Veröffentlicht unter Sonstiges
Kommentare deaktiviert für Menschen bitte nicht in die Waschmaschine tun
Die Top 10 Merkmale ›sub-optimaler‹ Dokumentation
(Gekürzte Übertragung des Artikel »Top 10 signs that documentation is craptacular« von Sarah O’Keefe, Scriptorium)
Es gibt eine Menge wirklich schrecklicher technischer Dokumentation draußen in der Welt. Sie ist inkohärent, nicht hilfreich und/oder hässlich. Die Inhalte wurden „geschrieben“ ohne auf grundlegende Prinzipien der technischen Kommunikation zu achten. Wenn sie mit Inhalten dieser Art konfrontiert sind, ist es wahrscheinlich nicht sinnvoll, die Implementierung eines superschlauen neuen Systems zu versuchen. Konzentrieren Sie sich stattdessen darauf, die Redaktion Schritt für Schritt vorwärts zu bewegen.
Hier sind die Top 10 der Anzeichen dafür, dass eine Dokumentation Müll ist:
10. Die Dokumentation enthält freiwillig mehr als eines der folgenden Dinge: Lose-Blatt-Sammlung, Änderungsseiten, Liste gültiger Seiten oder nummerierte Überschriften.
9. Es gibt keinen Redaktionsleitfaden.
8. Es gibt kein Template; oder gibt es ein Template, dem niemand folgt.
7. Die technischen Redakteure haben keine Fachkenntnisse.
6. Der technische Support weist Anrufer darauf hin, die Dokumentation zu ignorieren.
5. Der Zeitaufwand fürs Schreiben ist ungefähr so hoch wie der Aufwand für die Formatierung.
4. Die einzige elektronische Version der Dokumentation ist eine PDF-Datei.
3. In der HTML-Version der Dokumentation werden die Tabellen als Grafiken eingebunden, um „das ursprünglichen Erscheinungsbild zu erhalten“.
2. Es gibt keinen Index; oder der Index ist unbrauchbar.
1. Die Online-Version der Dokumentation widerspricht der Druckversion der Dokumentation.
Wenn schlechte Dokumentation festgestellt wurde, muss als erstes das Bewusstsein schaffen werden, dass gute Inhalte wertvoll für die Firma sind. Der genaue Business Case ist firmenspezifisch, aber einige allgemeine Wertversprechen sind:
- Gute Dokumentation reduziert Kosten für Kundenbetreuung (in der Regel durch eine Verringerung der Menge der Anrufe beim technischen Support).
- Gute Dokumentation erhöht die Kundenzufriedenheit.
- Gute Dokumentation ist für die Einhaltung gesetzlicher Vorschriften erforderlich.
Es gibt wohl einige leicht erreichbare Ziele, die schnell angegangen werden können:
- Erstellen Sie ein attraktives Template für Ihre Dokumentation
- Alle Autoren müssen das Template nutzen
- Implementieren Sie Single Sourcing für Inhalte, die identisch sein sollten
- Erstellen Sie eine nützliche elektronische Version Ihrer Inhalte (in der Regel etwas HTML-basiertes)
- Erstellen Sie einen nützlichen, gut bearbeiteten Index
Falls Sie bei diesen Schritten Hilfe benötigen, wissen Sie wo Sie Hilfe bekommen können. Nicht nur, aber auch bei Scriptorium Publishing.
Veröffentlicht unter Sonstiges
9 Kommentare
Decodeunicode – das Buch der Zeichen ist da
Das Poster zur Webseite http://decodeunicode.org/ habe ich natürlich, jetzt gibt es auch das Buch decodeunicode – Die Schriftzeichen der Welt von Johannes Bergerhausen und Siri Poarangan. Inhaltlich geht es weniger um die technischen Details des Unicode-Standards, sondern um einen Überblick über die Vielzahl der Zeichen.
Das Buch inszeniert den Kosmos der Schriftzeichen wie eine spannende Kreuzfahrt – mit Farbigkeit, vorzüglicher Navigation, verschiedenen Papiersorten, Zwischenseiten, Essays und Anhängen.
Weitere Infos einschließlich Musterseiten und Bestellmöglichkeit auf
Veröffentlicht unter Unicode
Kommentare deaktiviert für Decodeunicode – das Buch der Zeichen ist da