Schreiben Sie die Dokumente
Dieser Artikel benötigt zusätzliche Zitate zur Verifizierung. Bitte helfen Sie, diesen Artikel zu verbessern, indem Sie Zitate zu zuverlässigen Quellen hinzufügen. Material ohne Quellenangabe kann angefochten und entfernt werden.Find sources: “Strukturiertes Dokument” – Nachrichten – Zeitungen – Bücher – Wissenschaftler – JSTOR (April 2014) (Erfahren Sie, wie und wann Sie diese Vorlage entfernen können)
Ein strukturiertes Dokument ist ein elektronisches Dokument, bei dem eine Auszeichnungsmethode verwendet wird, um das Ganze und Teile des Dokuments mit verschiedenen Bedeutungen über ihre Formatierung hinaus zu kennzeichnen. So kann ein strukturiertes Dokument beispielsweise einen bestimmten Abschnitt als “Kapitelüberschrift” (oder “Codebeispiel” oder “Vierzeiler”) und nicht als “Helvetica bold 24” oder “Courier eingerückt” kennzeichnen. Solche Teile werden im Allgemeinen als “Komponenten” oder “Elemente” eines Dokuments bezeichnet.
Strukturierte Dokumente konzentrieren sich im Allgemeinen auf die Kennzeichnung von Dingen, die für eine Vielzahl von Verarbeitungszwecken verwendet werden können, nicht nur für die Formatierung. So ist beispielsweise die ausdrückliche Kennzeichnung von “Kapitelüberschrift” oder “Hervorhebung” für Systeme für Sehbehinderte weitaus nützlicher als lediglich “Helvetica bold 24” oder “italic”. In gleicher Weise ermöglicht eine sinnvolle Kennzeichnung der vielen Elemente auf einem technischen Informationsblatt eine viel bessere Integration in Datenbanken, Suchsysteme, Online-Kataloge usw.
Beispiel für eine Software-Dokumentation
Ein strukturiertes Dokument ist ein elektronisches Dokument, dessen Inhalt mit Hilfe einer Auszeichnungssprache wie HTML oder XML nach bestimmten Einschränkungen – dem so genannten Schema – in beschriftete Blöcke gegliedert ist. Bei strukturierten Dokumenten steht nicht die Präsentation für den Endbenutzer im Vordergrund, sondern die logische Gruppierung von Informationen. Wenn sie in den richtigen Situationen eingesetzt werden, lassen sich Dokumentinhalte leicht durchsuchen, aktualisieren und wiederverwenden. Für viele Unternehmen ist eine strukturierte Dokumentation jedoch ineffizient und nicht der Mühe wert, sie zu implementieren.
Die Kennzeichnung von Abschnitten in strukturierter Dokumentation macht es einfach, Abschnitte aus einem Dokument für die Verwendung in einem anderen zu übernehmen. Eine Tabelle zur Gerätekompatibilität kann beispielsweise auch in Texten wie Verkaufsbroschüren, auf der Unternehmenswebsite oder in Handbüchern für ähnliche Geräte verwendet werden. Wenn die Informationen in der Tabelle aktualisiert werden müssen, braucht ein technischer Redakteur nur eine einzige Kopie zu aktualisieren, um diese Änderung in vielen verschiedenen Dokumenten gleichzeitig vorzunehmen.
Dies ist besonders nützlich für übersetzte Projekte. Der aktualisierte Abschnitt muss nur einmal von einem einzigen Übersetzer übersetzt werden, was die Effizienz erhöht und mögliche Inkonsistenzen zwischen den Dokumenten verhindert. Ein weiterer Vorteil ist, dass alle Translation-Memory-Systeme XML verwenden, so dass dieses Format für jedes größere Übersetzungsprojekt nützlich ist.
Seite der technischen Dokumentation
Wenn Sie das richtige Tool verwenden, sind Sie nicht auf einen einzigen Ansatz festgelegt. Mit einem flexiblen Dokumentationstool wie Confluence ist es einfach, Artikel hinzuzufügen und zu bearbeiten und Themenstrukturen zu ändern. Ihr Team kann Ihre Dokumentation schnell an unterschiedliche Kundenanforderungen anpassen und bereitstellen, einschließlich der Veröffentlichung im Internet und des Exports als angepasste PDF- oder Word-Dokumente.
Definieren Sie Thementypen Sobald Sie sich für Ihre Struktur entschieden haben, ist es an der Zeit, einige Thementypen festzulegen, damit die Autoren entscheiden können, welche Arten von Inhalten sie wie schreiben sollen. Mit Hilfe von Thementypen können Sie Ihre Inhalte in organisierte Blöcke unterteilen und die verschiedenen Artikel, die Ihr Team schreiben wird, klassifizieren. Einige gängige Themenarten sind: Am besten ist es, für jeden Typ einen Leitfaden zu entwerfen und diesen dann in Vorlagen umzuwandeln. Diese Vorlagen dienen als Rezept für Ihr Team, um sich für ein Thema zu entscheiden und schnell loslegen zu können, wenn es einen Beitrag zu den Dokumenten leisten muss.Vorlagen helfen auch dabei, Inhaltsstrukturen und Designs innerhalb Ihrer Artikel durchzusetzen, so dass jeder in Ihrem Team die richtigen Informationen beisteuern kann, ohne dass Sie als Autor oder Manager doppelt arbeiten müssen.
Vorlage für die Dokumentation
Ein strukturiertes Dokument ist ein elektronisches Dokument, dessen Inhalt mit Hilfe einer Auszeichnungssprache wie HTML oder XML nach bestimmten Einschränkungen – dem so genannten Schema – in beschriftete Blöcke gegliedert ist. Bei strukturierten Dokumenten steht nicht die Präsentation für den Endbenutzer im Vordergrund, sondern die logische Gruppierung von Informationen. Wenn sie in den richtigen Situationen eingesetzt werden, lassen sich die Dokumentinhalte leicht durchsuchen, aktualisieren und wiederverwenden. Viele Unternehmen halten strukturierte Dokumentation jedoch für ineffizient und nicht der Mühe wert, sie zu implementieren.
Die Kennzeichnung von Abschnitten in strukturierter Dokumentation macht es einfach, Abschnitte aus einem Dokument für die Verwendung in einem anderen zu übernehmen. Eine Tabelle zur Gerätekompatibilität kann beispielsweise auch in Texten wie Verkaufsbroschüren, auf der Unternehmenswebsite oder in Handbüchern für ähnliche Geräte verwendet werden. Wenn die Informationen in der Tabelle aktualisiert werden müssen, braucht ein technischer Redakteur nur eine einzige Kopie zu aktualisieren, um diese Änderung in vielen verschiedenen Dokumenten gleichzeitig vorzunehmen.
Dies ist besonders nützlich für übersetzte Projekte. Der aktualisierte Abschnitt muss nur einmal von einem einzigen Übersetzer übersetzt werden, was die Effizienz erhöht und mögliche Inkonsistenzen zwischen den Dokumenten verhindert. Ein weiterer Vorteil ist, dass alle Translation-Memory-Systeme XML verwenden, so dass dieses Format für jedes größere Übersetzungsprojekt nützlich ist.