Christa Weidner | IT-Anwender, die wissen, was sie tun

StartIT-DokumentationVom Winde verweht …

Vom Winde verweht …

Eine Software-Dokumentation ist kein Roman, der fesselnd, abwechslungsreich und emotional beschreibend den Leser in den Bann ziehen soll. Eine Software-Dokumentation ist eine Betriebsanleitung, welche die Nutzung der Software beschreibt. Der Anwender wird diese Beschreibung in der Regel nicht von Anfang bis Ende lesen. Sondern er wird sie dann in die Hand nehmen, wenn er eine ganz bestimmte Informationen benötigt. Und dann möchte er diese schnell finden und seine Fragen müssen eindeutig beantwortet werden.

Wir schreiben nicht den Roman „Vom Winde verweht …“

sondern eine Software-Dokumentation, welche die folgenden Voraussetzungen erfüllt:

  • Informationen werden schnell gefunden.
  • Inhalte werden klar, präzise und eindeutig beschrieben.
  • Der Inhalt wird verstanden und kann, wie beschrieben, umgesetzt werden.