Geben Sie hier den Text ein.
Topicbasiertes Dokumentieren
Dieses Dokument ist topicbasiert geschrieben. Ein wesentlicher Grund dafür ist der Bezug zur Projektarbeit Wissensmanagement, welche das topicbasierte Verfassen von Dokumentationen, insbesondere für die Erstellung von klaren Anleitungen, beschreibt. Da im vorliegenden Dokument etliche, in sich abgeschlossene Themen behandelt werden, eignet es sich gut für diese Stukturierungsform und untermauert damit die im Wissensmanagement gemachten Aussagen.
 Topicbasierte Struktur |
Durch die topicbasierte Struktur ergibt sich die Navigation im Dokument. Topics lassen sich direkt aus dem Inhaltsverzeichnis anspringen oder es lässt sich sequentiell von Topic zu Topic oder zur oberen Hierarchieebene verzweigen. Auch wenn man sich das Dokument wie üblich in Kapiteln mit untergeordneten Abschnitten vorstellt, was die hierarchische Strukturierung der Topics unterstützt, bleibt wegen dem benutzten Schreibprogramm das Topic das Grundelement. Dies zeigt sich beispielsweise bei Hinweismeldungen mit Bezug zu Topics. So können Benutzer und Benutzerinnen folgende Meldungen zu sehen bekommen: •Zum Top-Topic •Zum nächsten Topic •Dies ist das letzte Topic Im Text selbst wird bei Verweisen auf Textstellen auch auf ein Topic statt auf ein Kapitel oder einen Abschnitt verwiesen. Dann heisst es beispielsweise: siehe Topic Software. Je nach Dokumentformat handelt es sich dann gleich um einen Topiclink, welcher nach dem Anklicken das referenzierte Topic anzeigt. |
Definition |
|---|
Topicbasiertes Dokumentieren ist für die Erstellung klarer Anleitungen unerlässlich. Es ist ein modularer Ansatz für die Erstellung von Inhalten. Der Inhalt ist um Themen herum strukturiert, die in verschiedenen Kontexten wiederverwendet und gemischt werden können. Jedes Thema hat einen klaren Zweck und einen Anfang, konzentriert sich auf ein Thema und benötigt keinen externen Kontext, um verstanden zu werden. Es hat einen klaren Anfang und ein klares Ende und löst in der Regel eine der Fragen des Benutzers bzw. hilft Benutzern und Benutzerinnen, eine einzelne Aufgabe zu erledigen. Quelle: [2] |
Dokumentformate
Dieses Dokument ist in mehreren Formaten verfügbar.
Dokumentationsstil
Schreibstil
