Geschütztes Leerzeichen:   oder   oder doch   ???

Das Problem: Spezielle Eigennamen sollen meist in Dokumenten nicht getrennt geschrieben werden. Dazu wird das geschützte Leerzeichen verwendet. In HTML ist   weit verbreitet. In XML (also auch DITA) muss das Zeichen jedoch erst in der DTD vereinbart werden und führt ohne Deklaration zu Validierungsfehlern.

Lösung: Es gibt zwei weitere Zeichen, die für das geschützte Leerzeichen in Frage kommen:
  oder  

Bei diesen konnte ich keinen Unterschied feststellen (oder irgendwo lesen), es ist wohl Geschmackssache für was man sich entscheidet.

Nebenbei bemerkt: Im Editor Oxygen funktioniert   weshalb ich lange nichts von dem Fehler bemerkt habe. Als ich jedoch die Transformation in Eclipse nachvollziehen wollte, wurde mir die Fehlermeldung angezeigt.

Ein Beispiel: Europäische Union

Posted in DITA, Experts | Tagged , , | Leave a comment

Mit besten Empfehlungen: Foxit Reader Version 5

Kostenlos, schlank und schnell, so kommt der alternative PDF Reader Foxit daher. Auch größere PDF Dateien werden im Nu geladen, und die neue Version bringt noch weitere sinnvolle Funktionen, z.B. die Zustandsspeicherung. Heisst, dass wenn ich eine PDF auf Seite 345 schließe, sie beim nächsten Öffnen auf der gleichen Seite startet. Sehr komfortabel und nützlich für all diejenigen, die das Layout einer PDF Datei anpassen müssen ;)

Ebenso nützlich sind die vielfältigen Editierfunktionen wie Markierung oder Unterstreichen. Auch eigene Anmerkungen können ergänzt werden. Dafür bezahlt man bei der Konkurrenz ordentlich!

Alles in allem: nur zu empfehlen!

Posted in PDF, Tools | Leave a comment

Word versus DITA

Ich vermute mal – auch ohne die Kenntnis spezieller Zahlen und Fakten – dass in mind. 90% der Büros Microsofts Office Anwendungen genutzt werden.

Wieso also die Software nicht auch nutzen, um Dokumentationen zu schreiben? Geht doch alles, Texte, Grafiken, Verzeichnisse, Bilder … was will man mehr? (denkt der Chef, der höchstwahrscheinlich keine Doku selbst verfasst ;) )

Auf der Microsoft Seite habe ich als Beschreibung für das Office Paket einmal gelesen: “Für den Alltagsgebrauch verwendbar, ohne Erfahrung in den speziellen Techniken …” (in diesem Sinne)

Jeder, der schon ein paar Einblicke im Bereich der Technischen Dokumentation gemacht hat weiss aber, dass dieser Aufgabenbereich keineswegs ohne Erfahrungen in speziellen Techniken funktioniert. Wieso also Office dafür verwenden?

Ok, es gibt sie natürlich, die Vorteile von Word als Textverarbeitungsprogramm:

  • Es ist keine Einarbeitungszeit bzw. extra Schulung notwendig.
  • (Fast) Jeder Mitarbeiter kann damit umgehen.
  • Die neuen Versionen arbeiten mit dem XML Standard. Hier gibt es aber auch Kritik, da die zugehörige Spezifikation mehr als 6000(!) Seiten umfasst und so für andere Anwendungen kaum umsetzbar ist.
  • Es sind verschiedene Ausgaben möglich, darunter auch PDF.

Wenn Word nicht ausreicht, gibt es eine Reihe kommerzieller Programme für die Erstellung Technischer Dokumentationen, die Word als Editor verwenden. Davon habe ich einige getestet und muss sagen, ich habe keins gefunden, was einfach zu bedienen war (Schulung wäre notwendig) oder den Preis gerechtfertigt hätte. Die oft versprochene einfache Konvertierung von alten Word-Dokumentationen war ebenfalls nicht realisierbar ohne aufwendige Nacharbeiten.

Vorteile von DITA (als Vertreter eines XML Standards zu sehen):

  • Unabhängigkeit von Anbietern, es kann aus einer Vielzahl von Editoren gewählt werden
  • Eigenentwicklungen sind möglich
  • Erfahrung in der Nutzer durch jahrzehntelange Entwicklung vorhanden (dementsprechend auch viele Tutorials und Anleitungen)
  • Kontinuierliche Weiterentwicklung durch OASIS
  • Breite Umsetzung in Anwendungen wie Editoren und Content Management Systemen vorhanden

Der einzige Nachteil, den ich dabei sehe, ist der Einarbeitungsaufwand, den man nicht unterschätzen sollte. Aber das ist ja bei jeder neuen Software der Fall.

Mein Fazit:

Für eine Standard-Dokumentation, die als gedrucktes Handbuch oder PDF gebraucht wird, kann Word durchaus die Zwecke erfüllen. Wird eine bestimmte Seitenanzahl überschritten (Schmerzgrenze bei mir waren 100 Seiten), würde ich eine andere Methode wählen.

Sollen zudem auch andere Ausgaben generiert werden (wie z.B. eine Web-Hilfe, Java-Hilfe), welche nach dem Single-Source-Prinzip nicht alle einzeln erstellt werden sollen, kommt man um die Anwendung des XML Standards und Redaktions-Tools nicht herum.

Ein wichtiger Tipp zum Schluss: Das Argument “Word benutzen alle, das muss doch einen Grund haben, also benutzen wir es auch!” kann durchaus entkräftet werden! Ich habe etwa 3 Monate gebraucht, aber es hat geklappt! Also nicht entmutigen lassen ;)

Posted in DITA | Tagged , , , , | Leave a comment
powered by C3N Stats