Produktdokumentation, die Benutzern wirklich hilft

In diesem Vortrag berichte ich von meinen Erfahrungen bei der Überarbeitung einer Dokumentation, die sich an Developer, Softwarearchitekten und codende Power User richtet. Dabei geht es um ein visuelles Testing-Tool, das Playwright ähnelt und in meinem derzeitigen Unternehmen eingesetzt wird.

Ursprünglich war die Dokumentation so unbrauchbar, dass nur ein Drittel der Benutzer das Produkt lokal zum Laufen brachte. Hatten sie diese Hürde genommen, waren sie dennoch verloren und konnten nicht herausfinden, wie sie Features sinnvoll einsetzen sollen. Die mangelhafte Dokumentation führte außerdem zu einer hohen Anzahl an Supportanfragen, da Selbsthilfe nicht möglich war. Das Onboarding war ebenfalls eine Herausforderung.

Anhand von Beispielen erläutere ich die einzelnen Phasen bei der Qualitätsverbesserung der Dokumentation.

Segmentierung hilft dabei, die Dokumentation so zu strukturieren, dass sie zu den spezifischen Bedürfnissen der Konsumierenden passt. Außerdem gehe ich darauf ein, wie wichtig es ist, präzise Lernziele zu formulieren, die den inhaltlichen Fokus optimieren. Darüber hinaus zeige ich, wie man mit Docs-as-Code automatisiert auf verständliche Sprache, korrekte Rechtschreibung und stilistische Konsistenz testet.