Die neue gridscale Produktdokumentation

Datum: 16.08.2021

Interview mit Marc Harris, unserem Head of Product, zu Konzept und Erstellung der gridscale Produktdokumentation. Die Dokumentation ist ein wichtiger neuer Baustein in der Kommunikation mit unseren Partnern und Kunden.

Eine Cloud-Infrastruktur ist ein dynamisches Produkt mit unterschiedlichen Ebenen, Komponenten, Funktionen und Möglichkeiten – vom Public Cloud Nutzer bis zum gridscale Hybrid Core für unsere Partner. Diese Struktur wird immer weiter verbessert, weiterentwickelt und ergänzt. Je größer dieses System wird, desto wichtiger ist es, alle technischen Informationen zentral zu dokumentieren und den Nutzern in einer verständlichen und übersichtlichen Wissensdatenbank zur Verfügung zu stellen.

Marc, was war der Ausgangspunkt eures Projekts? Warum habt ihr euch entschlossen, euch grundlegend mit einer neuen gridscale Produktdokumentation zu befassen?

Das waren zwei Gründe: eine Vereinfachung des Onboardings und eine Verbesserung der Produktkommunikation. Für die Erstellung einer Produktdokumentation braucht man natürlich eine Menge Zeit. Mit der 4DX-Methode, die wir bei  gridscale einsetzen, können wir 20 Prozent unserer Arbeitszeit in die Umsetzung wichtiger langfristiger Ziele investieren. Auf diese Weise haben wir im Produktteam das Konzept der Dokumentation entwickelt und einen großen Teil der Inhalte erstellt.

Beim Onboarding ist es unser Ziel, dass sich unsere Public Cloud in großen Teilen selbst erklärt. Durch ein gutes User Interface und eine Dokumentation, die zum Teil des Produkts wird. Aus diesem Grund verlinken wir einzelne Funktionen direkt mit dem entsprechenden Abschnitt der neuen Dokumentation.

Bei unseren Whitelabel-Partnern wird die gridscale Cloud zum Produkt des Partnerkunden. Was hat das für einen Einfluss auf die Dokumentation?

Einen sehr großen. Unter den Updates und Weiterentwicklungen sind Dinge, die der Partner wissen muss, bevor der Endkunde sie weiß. Mit der Dokumentation kann der Partner die Neuerung nachzuvollziehen, bevor er sie weitergibt. Durch unsere Release-Notes weiß er schon, dass sich etwas ändern wird. Wir schicken ihm dann einen Link auf die aktualisierte Dokumentation und der Partner sieht im Detail, was sich für ihn und seine Kunden ändert.

Hast du dafür ein konkretes Beispiel?

Vor Kurzem haben wir verschiedene Kubernetes Versionen abgeschaltet und durch eine neue Version ersetzt. Darüber waren die Kunden natürlich informiert, aber ein Partner hatte Detailfragen zur neuen Version. Er bekam den Link zur geänderten Stelle in der Dokumentation und damit war ihm sofort alles klar. Er konnte es schnell in seine Kundenkommunikation einbinden. Wir haben gemerkt, dass dieser Kommunikationsfluss sehr wichtig ist.

Ein anderer Aspekt bei den Partnerkunden ist, dass nicht jeder Partner denselben Funktionsumfang anbietet. Wir brauchen also in Zukunft für viele Whitelabel-Plattformen eine eigene Produktdokumention. Die Möglichkeit, eine kundenspezifische Dokumentation als Whitelabel in das Produkt einzubinden, wird deshalb demnächst kommen. Mit einer allgemeinen, zentralen gridscale Dokumentation kommen wir hier nicht weiter. Deshalb können wir auch keine herkömmliche Wiki-Plattform nutzen.

Was nutzt ihr stattdessen? Mit welchen Tools habt ihr die gridscale Produktdokumentation gebaut?

Wir nutzen das Open Source Framework Hugo, ein Generator für statische Seiten. Darauf verwenden wir Doks, ein spezielles Dokumentationstemplate. Die Dokumentation besteht also komplett aus statischen HTML-Seiten und ist in der Bedienung extrem schnell. Als reines Code-Projekt lässt es sich schnell und einfach an einzelne Partnerkunden anpassen und in ihr Produkt integrieren.

Was war für euch die größte Herausforderung bei der Erstellung der Dokumentation?

Die Auswahl und Anpassung bereits vorhandener Produktinformationen. Hier gibt es bei uns natürlich schon eine ganze Menge, von Tutorials bis zu unseren bisherigen FAQ. Vieles mussten wir komplett neu schreiben. Um das alles zu sortieren und zu bewerten, sind eine Menge Stunden eingeflossen. Die Dokumentation soll eine Wissensdatenbank für unsere Kunden sein, kein Tutorial. Es war wichtig, hier die richtigen Schwerpunkte zu setzen, aber ich glaube, das ist uns gut gelungen.

Hier geht es zur neuen Produktdokumentation.

Zurück zur Übersicht