Für jeden Kunden den besten Projektablauf

Der Ablauf eines Dokumentationsprojekts durchläuft verschiedene Phasen. So sieht der Projektablauf eines Dokumentationsprojekts mit people text aus, im Detail besprechen wir den Ablauf mit Ihrer Dokumentationsabteilung.

Die Entwicklung der Benutzerdokumentation sollte Teil der gleichen Prozesse sein wie der Lebenszyklus des Softwareprodukts. Und idealerweise in Verbindung mit der Entwicklung der Software erfolgen, so dass die Software und die Benutzerdokumentation gemeinsam getestet, verteilt und gewartet werden können. Die Spezifikation der gesamten Dokumentation, einschließlich der Online-Dokumentation und der gedruckten Dokumentation, sollte ein Teil der Entwicklung des Softwareprodukts als Ganzes sein, nicht als separate Aufgabe. Obwohl eine Benutzerdokumentation nicht fertiggestellt werden kann, bevor das Softwareprodukt vollständig entwickelt ist, profitieren sowohl die Benutzerdokumentation als auch das Softwareprodukt von einer gleichzeitigen Entwicklung.

Grundsätzlich sind verschiedene Projektszenarien zu unterscheiden:

  • Integration in agile Entwicklungsumgebungen mit zugewiesenen Tasks in Sprintzyklen. Der Informationserstellungsprozess ist vorgegeben: Projektanforderungen festlegen. Aufgaben der Zielgruppe  analysieren. Dies kann zeitgleich mit der Entwicklung stattfinden
  • Asynchron zur Entwicklung geplanter Dokumentation. Der Informationserstellungsprozess muss geplant werden.

Wie läuft das Dokumentationsprojekt ab?

Ihre Ressourcen sind zu knapp, um die Technische Dokumentation selbst zu erstellen? Wir können das für Sie erledigen. Wir besprechen den Projektablauf und egal, ob Sie ein Handbuch oder eine Online-Hilfe benötigen, wir arbeiten mit dem Autorensystem Ihrer Wahl.

Wir wollen für jeden Kunden den besten Lösungsansatz:

  • Wir planen die Erstellung Ihrer Technischen Dokumentation für Sie. Dabei stimmen wir Ihre unternehmens- und branchenspezifischen Ziele mit Ihnen ab. Dazu gehört es, die entsprechenden Richtlinien mit den Sicherheitsanforderungen umzusetzen. Unsere Anleitungen sind beispielsweise entsprechend der Norm DIN EN 82079 aufgebaut. Die Sicherheitshinweise sind gemäß ANSI Z535 formuliert.
  • Wir erstellen ein Konzept für Ihre Technische Dokumentation und recherchieren anschließend die notwendigen Informationen in enger Kooperation mit Ihrer Entwicklungsabteilung. Dabei sammeln wir so viele Informationen wie möglich. Wenn Sie agil entwickeln, sind wir Teil des Scrum-Teams. Unser Kontakt zur Entwicklung ist näher und so können wir neue Funktionen reibungsloser umsetzen. Als Mitglied eines Scrum-Teams ist die Erstellung der Technischen Dokumentation jederzeit transparent
  • Wir schreiben oder aktualisieren Ihre Technische Dokumentation. Dabei halten wir die Optimierungspotenziale im Auge. Sie steigern damit die Wirtschaftlichkeit im Projektverlauf. Zu den Optimierungspotenzialen gehören zum Beispiel die übersetzungsfreundliche Erstellung der Technischen Dokumentation durch Standardisierung. Auch der Einsatz von Illustrationen hilft, die Übersetzungskosten zu senken
  • Wir führen das Review in Zusammenarbeit mit Ihrer Entwicklungsabteilung durch. Nachdem wir die Korrekturen eingearbeitet haben, führen wir ein weiteres internes Review als qualitätssichernde Maßnahme durch.
  • Wir publizieren die Technische Dokumentation in das entsprechende Format, beispielsweise ein gedrucktes Handbuch oder zum Online-Konsumieren.