Dokumentation und Anleitung

Eine nachvollziehbare Dokumentation von Datenmodell, Auszeichnungsregeln und Arbeitsabläufen erleichtert die konsistente Arbeit mit TEI-XML und unterstützt die langfristige Pflege und Nachnutzung der Daten. Ich erstelle projektspezifische Dokumentationen und Anleitungen, die technische Festlegungen mit verständlichen Erläuterungen und konkreten Anwendungsbeispielen verbinden.

Taggingdokumentationen

Ich dokumentiere projektspezifische Auszeichnungsrichtlinien und die Verwendung von Elementen, Attributen und Attributwerten. Die Dokumentation kann unmittelbar in das ODD integriert und damit eng mit der formalen Spezifikation des Datenmodells verbunden werden. Codebeispiele aus dem jeweiligen Projekt veranschaulichen die vorgesehenen Auszeichnungslösungen und erleichtern ihre einheitliche Anwendung.
Alternativ oder ergänzend erstelle ich eigenständige Taggingdokumentationen, beispielsweise im DITA-Format oder in Markdown. Damit können umfangreichere Dokumentationen modular aufgebaut, unabhängig vom Schema gepflegt und für unterschiedliche Ausgabeformate bereitgestellt werden.

Anleitungen für Projektteams

Neben der technischen Dokumentation erstelle ich praxisorientierte Anleitungen für die Arbeit mit den projektspezifischen Daten und Workflows. Sie können einzelne Arbeitsschritte, empfohlene Vorgehensweisen und projektinterne Konventionen beschreiben und so als gemeinsame Arbeitsgrundlage für Projektteams dienen.

Auf Wunsch entwickle ich einfache projektspezifische Frameworks für den Oxygen XML Author. Sie bündeln Schema, Darstellungsregeln, Validierung und angepasste Funktionen in einer gemeinsamen Arbeitsumgebung und erleichtern Projektteams so die konsistente Erfassung und Bearbeitung ihrer TEI-Daten.

Ziel sind verlässliche Arbeitsgrundlagen, die nicht nur festhalten, wie Daten strukturiert und ausgezeichnet werden sollen, sondern Projektteams auch dabei unterstützen, die getroffenen Festlegungen im Arbeitsalltag konsistent umzusetzen.

Projektreferenzen

TEI-Datenmodellentwicklung mit ODD – DITA-Dokumentation – Frameworkentwicklung

Weitere Services und Projekte