Dokumentation

Kurzbeschreibung ...

Die Benutzerdokumentation ist integraler Bestandteil eines Produkts und bestimmt wesentlich das Qualitätsempfinden des Benutzers.

Die Systemdokumentation ist die implementierungstechnische Beschreibung des Software-Produkts und bestimmt sehr wesentlich die Aufwände und die Qualität bei der Weiterentwicklung oder Änderung bestehender Systeme.

 

   

Unsere LEISTUNGEN ...

• Benutzerdokumentation erstellen:
  (Einleitung, Arbeiten mit dem System, Referenzteil, Meldungen und Reaktion auf Fehler, Administration, Schnittstellen)
• Erstellen einer System-Dokumentation:
  - kurzes Vorbereitungsgespräch mit dem Entwicklungs-/Projektleiter und den Programmierern
  - systematische Erstellung einer umfassenden Dokumentation des Systems und des Quell-Codes
    (bei Bedarf auch unter Mitwirkung der Entwickler oder des Projektleiters)
• Dokumentations-Workshop:
  - Erarbeitung der für die Dokumentation notwendigen Struktur und Vorgaben
    (gemeinsam mit den Entwicklern und Projektleiter)
  - Definition eines Leitfadens / einer Vorgehensweise zu Erstellung der Dokumentation

Dies sagen Kunden über Software Quality Lab...  

Weitere Infos zum Leistungsbereich ...

In der Praxis ist die Benutzerdokumentation jedoch das ungeliebte Kind der Softwareentwickler, häufig ans Ende des Projektes geschoben und inhaltlich oft eine puristische Beschreibung von Masken und Feldern. Der Benutzer ist frustriert, denn er findet keine Antwort auf seine spezifische Frage.

Die Benutzerdokumentation ist für Sofwtare-Produkte zwingend (auch gesetzlich) erforderlich, kann jedoch abhängig von der Projektart und Kenntnisstand des Kunden unterschiedlich ausgeprägt sein.

 

Die Systemdokumentation besteht aus mehreren unterschiedlichen Dokumentationsbereichen (konzeptuelle System-Beschreibung, Datenbank-Beschreibungen, Source-Code-Dokumentation, ...).

Alle diese Bestandteile sind wichtig, um einen langfristigen Investitionsschutz des entwickelten Systems zu erreichen, da andernfalls im Laufe der Zeit das Wissen über die Zusammenhänge und die technischen Details immer mehr verloren geht oder eventuell der Weggang eines beteiligten Mitarbeiters kurzfristig große Wissenslücken hinterlässt.

Um langfristig (ev. auch in anderen Projekten) Nutzen aus dem erstellten System zu ziehen und die Investitionen zu sichern, ist eine Systemdokumentation unbedingt erforderlich.

© Software Quality Lab GmbH
4041 Linz, Gewerbepark Urfahr 30, BG4
www.software-quality-lab.at

Tel.: +43 732 890072-0
Fax: +43 732 890072-411
info(at)software-quality-lab.at