Konzept

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Um dem Nutzer Hintergrundwissen oder weiterführende Informationen zur Verfügung stellen zu können, wird in DITA der Topictyp „Konzept“ verwendet. Ein Topictyp "Konzept" beantwortet die Frage „Was ist ..?“

Die Grundstruktur für eines Topictyps "Konzept" sieht wie folgt aus:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept id="kapitel8_concept">
    <title>Informationen zum Ausschalten eines Computers.
    </title>
    <conbody>
        <p>Ein Computer sollte immer ordnungsgemäß beendet werden, da ansonsten unter Umständen Daten verloren gehen können.</p>
    </conbody>
</concept>

Wie jedes DITA-Topic beginnt auch das Topic vom Typ „Konzept“ mit einer XML- und der DOCTYPE-Deklaration. In der DOCTYPE-Deklaration wird auf die concept.dtd verwiesen.

Das Wurzel-Element des Topictyps „Konzept“ ist das <concept>-Element. Im Wurzel-Element <concept> muss eine eindeutige Kennung, das heißt ID zugewiesen werden.

Das <title>-Element enthält einen Titel für das Topic vom Typ „Konzept“ – der wie alle guten Titel – möglichst aussagekräftig sein sollte.

Das <conbody>-Element legt die Struktur des Topictyps „Konzept“ fest. Innerhalb des <conbody>-Elements ist im Gegensatz zum Topictyp „Aufgabe“ keine besondere Struktur vorgesehen. Hier können Sie die zahlreich von DITA zur Verfügung gestellten Block-Elemente verwenden, um den Inhalt zu strukturieren. Weitere Informationen zu Block-Elementen erhalten Sie in Block-Elemente.

Ähnlich wie beim generischen Topic ist beim Topictyp „Konzept“ zu erkennen, dass die Struktur der Topics dem Technischen Redakteur keine Hinweise darauf gibt, wie die Inhalte in einem Topic unterzubringen sind. Tatsächlich stellen diese beide Topictypen Container dar, in denen Informationen erfasst werden können. Hinweise zur Strukturierung von Informationen in den beiden Topictypen werden in DITA kaum gegeben. Hier helfen dann Strukturierungsmethoden wie Funktionsdesign oder Information Mapping™ dem Technischen Redakteur weiter, über die definiert werden kann, wie Informationen strukturiert werden sollen.

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema DITA bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

XLcontent Verlag, Pflegerstraße 40, 81247 München