Metainformationen zur Seite
  •  

Wie dokumentieren?

Folgende konkrete Dokumentationsempfehlungen (vgl. Rüping 2003, S. 40–81) sind für die Dokumentation hilfreich:

  • Trennung von Beschreibung und Bewertung
  • Untersetzung abstrakter Beschreibungen durch verständnisfördernde Beispiele
  • Gute Strukturierung des Textes mittels Überschriften und darauf basierender Inhaltverzeichnisse
  • Überblickschaffendfgdf df e Diagramme einsetzen, um Zusammenhänge aufzuzeigen
  • Kompakte Darstellung von Informationsmengen in Tabellen
  • Leserichtlinien für Dokumente helfen sich in ihnen zurechtzufinden
  • Nachvollziehbare Verlinkung von zusammen gehörigen Dokumenten
  • Dokumentenhistorie verschafft Klarheit über die Aktualität und Gültigkeit der Informationen