Produktdokumentation, die Benutzern wirklich hilft

Unzureichende Docs für Softwareentwickelnde können dem Erfolg eines Produkts abträglich sein. Softwareentwickelnde suchen nach effizienten Problemlösungen, und wenn euer Produkt diese nicht bietet, werden sie schnell weiterziehen.

Ich berichte von meinen Erfahrungen bei der Überarbeitung der Dokumentation für Softwareentwickelnde in meinem derzeitigen Unternehmen. Ursprünglich war die Dokumentation so unbrauchbar, dass nur ein Drittel der Benutzer das Produkt lokal zum Laufen gebracht hat. 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.

In diesem Vortrag erläutere ich anhand von Beispielen die einzelnen Phasen zur 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.