Themenstatus

Mit dem Status-System für Themen in Dr.Explain behalten Sie den Fortschritt Ihrer Arbeit im Blick. Weisen Sie einem Abschnitt einen bestimmten Status zu, der ihn in der Abschnittsstruktur mit der entsprechenden Farbe markiert.

Wie arbeitet man mit dem Abschnittsstatus in Dr.Explain?

Um einer Thema einen Status zuzuweisen, klicken Sie auf das entsprechende Symbol in den Abschnittseigenschaften. Die Logik der Statusvergabe können Sie selbst festlegen oder sich an dem unten vorgeschlagenen Schema orientieren.

Wenn Sie mit dem Schreiben eines Abschnitts noch nicht begonnen haben – markieren Sie ihn grau. Das erinnert Sie und Ihr Team daran, dass dieses Thema noch nicht fertig ist. Gelb bedeutet, dass am Thema geschrieben wird und daran gearbeitet wird. Rot werden Abschnitte markiert, die auf Prüfung oder Freigabe warten. Grün zeigt fertige Themen an, die vollständig ausgearbeitet und befüllt sind.

Diese Funktion verwandelt die Struktur der noch nicht fertigen Dokumentation in eine Heatmap, die den Fortschritt aller Teile Ihres Projekts anzeigt. Dank des Abschnittsstatus können Sie den Schreibprozess der Dokumentation verfolgen und die weitere Arbeit planen.

Beispiele für mit Dr.Explain erstellte Benutzerdokumentationen

Benutzerdokumentation wird, wie jedes andere Dokument auch, ständig aktualisiert. Dabei ist es wichtig, den Gesamtüberblick zu behalten: Welche Abschnitte sind abgeschlossen und müssen auf den neuesten Stand gebracht werden, welche befinden sich noch in der Entwicklung usw. In Dr.Explain kann der Autor den Arbeitsaufwand erkennen und die Prioritäten der Aufgaben einschätzen.

Welche Vorteile bieten sich Ihnen mit Dr.Explain?

• Visuelle Fortschrittskontrolle. Die Heatmap ermöglicht eine sofortige Einschätzung, welcher Teil der Dokumentation fertig ist und welcher Aufmerksamkeit benötigt – ohne jeden Abschnitt öffnen zu müssen.
• Vereinfachung der Teamarbeit. Alle Autoren sehen den aktuellen Stand der Aufgaben: wer woran schreibt, was in der Prüfung ist und was nicht mehr angefasst werden muss.
• Unterstützung bei der Planung. Die Status helfen, die Arbeitslast gleichmäßig zu verteilen, indem sie 'rote' (problematische) Bereiche identifizieren, die Eingriffe erfordern.
• Prozesstransparenz für die Leitung. Ein Manager oder leitender Redakteur kann jederzeit in wenigen Sekunden den Gesamtfortschritt des Projekts bewerten.
• Komfort bei der Pflege mehrerer Versionen. Bei der Aktualisierung der Dokumentation für eine neue Produktversion helfen die Status, den Überblick zu behalten, welche alten Abschnitte bereits aktualisiert wurden.

Für wen ist Dr.Explain geeignet?

Dr.Explain eignet sich für Experten und Einsteiger: Erstere finden darin Werkzeuge zur Umsetzung von Möglichkeiten, die über Standarddokumentation hinausgehen, Letztere erstellen leicht ihr erstes Projekt, das modernen Anforderungen entspricht. Sie sollten Dr.Explain installieren, wenn:

• Sie eine Gruppe von Autoren leiten. Die Heatmap liefert ein objektives Bild des Entwicklungsfortschritts und hilft bei der Aufgabenverteilung.
• Sie als technischer Redakteur an großen Projekten arbeiten. Die Status helfen, bei Dutzenden oder Hunderten von Seiten nicht den Überblick zu verlieren und zeigen, welche Teile abgeschlossen sind.
• Ihr Team Dokumentation in mehreren Sprachen pflegt. Die Status ermöglichen die Synchronisation der Arbeit von Übersetzern und Redakteuren.
• Sie als Entwickler Releases der Benutzerdokumentation planen. Die Status vereinfachen die Versionskontrolle vor dem Export.
• Sie als Autor Ihren persönlichen Arbeitsprozess optimieren möchten. Auch bei Einzelarbeit helfen die Status, 'Engpässe' zu erkennen und unfertige Abschnitte nicht zu vergessen.

Nutzer über die Arbeit mit dem Abschnittsstatus in Dr.Explain

'Wie sich beim Testen von Dr.Explain herausstellte, lässt sich das Design der Hilfe erstens leicht anpassen. Wir konnten das gewünschte Design schnell umsetzen. Zweitens gefiel uns die Möglichkeit, Status für Abschnitte zu vergeben. Das ist sehr praktisch, besonders in unserem Fall, wo wir die Hilfe in mehreren Sprachen pflegen müssen.'

Olga Mikheeva, Leiterin der Dokumentationsabteilung bei ELMA

'Die Möglichkeit, einen Abschnittsstatus zu vergeben, erwies sich ebenfalls als sehr praktisch. Besonders nach dem Import einer alten Hilfeeversion kann man so leicht nachverfolgen, welche Abschnitte aktualisiert werden müssen, in welchen noch Änderungen vorgenommen werden und welche bereits überarbeitet und aktuell sind.'

Natalya Obukhova, Business Analystin bei CRM Expert

'Sie haben die Möglichkeit, einfach die Stammknoten zu markieren, damit sie ausgeblendet werden, und dann eine Dokumentation zu erstellen, die nur das Sichtbare enthält.'

David Swindon, Chief Information Officer der Trustco Group Holdings

Häufig gestellte Fragen (FAQ)

Siehe auch

• Verwalten der Projektstruktur
• Stichwortverzeichnis
• Sperren von Themen