NEHMEN SIE
KONTAKT MIT UNS AUF

Wie können wir Ihnen helfen? Senden Sie uns eine kurze Nachricht und wir melden uns umgehend bei Ihnen.

Dokumentation

Dokumentation

Eine systematische und handlungsorientierte Dokumentation unterstützt den Entwurfsprozess und die produktive Nutzung der Software durch Anwender und Administratoren. Dadurch trägt sie nachhaltig zum Projekterfolg bei.

Eine systematisch aufgebaute Anwenderdokumentation ist in nahezu allen Projektphasen vorteilhaft.

Natürlich soll die Dokumentation nach Projektende die Anwender und Administratoren beim Einsatz der Software unterstützen. Sie hilft aber auch bereits während der Entwicklung, ein gemeinsames Verständnis aller Projektbeteiligten über die abzubildenden Prozesse und Funktionen zu schaffen.

Die Dokumentation sollte dabei so kurz wie möglich sein - aber eben auch nicht kürzer. Redundanzen sollten, da sie Mehraufwände bei der Pflege und die Gefahr von Inkonsistenzen zur Folge haben, soweit wie möglich vermieden werden. Schließlich sollte ein Regelwerk vorhanden sein, das die Autoren darin unterstützt, die richtigen Informationen an den richtigen Stellen der Dokumentation zu hinterlegen.

Wir unterstützen die Umsetzung dieser Anforderungen durch Single Source Publishing auf der Basis von XML-Standards wie des DITA Open Toolkits sowie durch den Einsatz eines auf das jeweilige Projekt angepassten Redaktionsleitfadens.