Öffentliche Dokumentation: Docs extern veröffentlichen

Sie haben Wochen damit verbracht, die interne Dokumentation Ihres Unternehmens zu erstellen und zu ordnen. Jetzt müssen Sie einen Teil davon mit Kunden, Partnern und Auftragnehmern teilen.

Dabei bleiben Ihnen drei wenig ideale Optionen:

1. Die Dokumente als PDF exportieren. Wenn sich die Anleitungen ändern, müssen Sie allerdings neue Dateien verschicken, während ältere Kopien weiter im Umlauf bleiben.
2. Eine separate Wissensdatenbank für externe Nutzer anlegen. Das Problem: Änderungen an Ihren internen Anleitungen müssen in die externen Kopien übertragen werden. Verpassen Sie ein Update, folgen Leser womöglich Anleitungen, die Ihr Team längst ersetzt hat.
3. Externen Nutzern Zugriff auf Ihre interne Wissensdatenbank geben. Ohne sorgfältig eingegrenzte Berechtigungen könnte ein Auftragnehmer, der an einem Projekt arbeitet, aber vertrauliche Informationen oder Dokumente sehen, die für ein anderes Projekt bestimmt sind.

Es gibt jedoch einen vierten und besseren Weg, öffentliche Dokumentation zu erstellen: ausgewählte Seiten aus Ihrer bestehenden Wissensdatenbank veröffentlichen und interne Dokumente privat halten.

Wir gehen durch, was Sie veröffentlichen sollten, wie Sie den Zugriff für verschiedene Zielgruppen steuern und wie Sie Ihre externe Dokumentation aktuell halten.

Das Wichtigste in Kürze

• Öffentliche Dokumentation sollte nur die Teile Ihres bestehenden Wissens freigeben, die Kunden, Partner oder Auftragnehmer brauchen.
• Öffentliche Seiten eignen sich für allgemein nützliche Anleitungen, aber das Abschalten der Suchmaschinenindexierung schränkt nicht ein, wer einen öffentlichen Link öffnen kann.
• Auftragnehmer und Partner sollten nur Zugriff auf die Dokumente oder Channels haben, die sie für ihre Arbeit brauchen, mit separat vergebenen Bearbeitungsrechten.
• Wer aus einem gepflegten Dokument veröffentlicht, hält externe Anleitungen im Einklang mit den Updates des internen Teams.
• Prüfen Sie vor dem Teilen eines Dokuments verlinkte Dateien, verschachtelte Seiten, Sucheinstellungen und das, was ein nicht angemeldeter Leser tatsächlich öffnen kann.
• Setzen Sie auf spezialisierte Software, wenn Ihre externe Dokumentation Support-Ticket-Workflows, versionierte API-Referenzen oder interaktive API-Tests braucht.

Was ist öffentliche Dokumentation?

Öffentliche Dokumentation (oder nach außen gerichtete Dokumentation) bezeichnet alles, von Anleitungen bis zu Handbüchern und Referenzmaterial, was ein Unternehmen Personen außerhalb seiner Organisation zur Verfügung stellt, darunter Interessenten, Kunden, Partner und Auftragnehmer.

Sie ermöglicht Selbsthilfe: Leser können ein Produkt bewerten, Aufgaben erledigen oder Abläufe befolgen, ohne für jede Antwort Mitarbeitende zu kontaktieren.

Typische Beispiele:

• Onboarding-Anleitungen für Kunden und Anleitungen zur Fehlerbehebung, die Menschen beim Einstieg und beim Lösen von Problemen helfen.
• Produkthandbücher und Benutzerdokumentation, die Funktionen, Einstellungen und Workflows erklären.
• API-Referenzen und Integrationsanleitungen, mit denen Entwickler ein Produkt bewerten oder anbinden können.
• Ressourcen für Partner und Auftragnehmer, die erklären, wie die Arbeit mit Ihrem Unternehmen abläuft.

So veröffentlichen Sie öffentliche Dokumentation

Eine Produktanleitung für Kunden braucht zum Beispiel möglicherweise andere Freigabeeinstellungen als ein Projektbriefing für einen Auftragnehmer.

Bevor Sie etwas veröffentlichen, müssen Sie festlegen, was jede Zielgruppe sehen darf.

Entscheiden Sie, was öffentlich wird und was intern bleibt

Gehen Sie Ihre bestehenden Dokumente durch und ermitteln Sie die Anleitungen, die ein externer Leser tatsächlich braucht. Ein Kunde, der ein Konto einrichtet, braucht die Schritte und Screenshots für diese Aufgabe, aber nicht Ihren Eskalationsprozess, private Kontonotizen oder Pläne für unveröffentlichte Funktionen, selbst wenn all diese Details in derselben internen Anleitung stehen.

Sortieren Sie das Material bei der Durchsicht in drei Gruppen:

• Öffentlich: Anleitungen zu veröffentlichten Produkten, allgemeine Anleitungen zur Fehlerbehebung und öffentliche Integrationsanforderungen ohne eingeschränkte Informationen.
• Intern (Prüfung erforderlich): interne Prozessdokumentation, die kundenrelevante Schritte neben Notizen nur für Mitarbeitende enthält. Entfernen Sie die internen Informationen oder bereiten Sie eine separate, freigegebene öffentliche Version vor.
• Vertraulich oder eingeschränkt: Zugangsdaten, identifizierbare Kundendaten, vertrauliche kommerzielle Konditionen, unveröffentlichte Funktionen und interne Entscheidungen, die Leser außerhalb des Unternehmens nicht sehen dürfen.

Prüfen Sie auch Screenshots, Anhänge, Links und Unterdokumente. Eine Seite kann keinerlei vertraulichen Text enthalten und trotzdem auf eine Datei verlinken, die nie für externe Leser gedacht war.

Ordnen Sie jeder Zielgruppe die passende Zugriffsebene zu

Wenn Sie entschieden haben, was geteilt werden darf, legen Sie fest, wer jedes Dokument öffnen darf.

Braucht jeder mit dem Link Zugriff, oder sollen sich Leser anmelden? Lesen sie nur Anleitungen, oder müssen sie kommentieren oder bearbeiten? Diese Antworten bestimmen, welche Freigabeoption Sie verwenden.

In dieser Phase können Sie auch das Prinzip der minimalen Rechtevergabe anwenden: In Slite können Sie Auftragnehmern und Partnern zum Beispiel nur Zugriff auf die Dokumente geben, die sie brauchen, und Autorenrechte nur dann vergeben, wenn sie bearbeiten müssen. Entziehen Sie den Zugriff, wenn ein Projekt endet oder sich Zuständigkeiten ändern. Prüfen Sie regelmäßig öffentliche Links und wer sie veröffentlichen darf.

Veröffentlichen Sie aus einer Quelle, damit die externe Version aktuell bleibt

Wenn Ihr Team die Anleitung zur Kontoeinrichtung aktualisiert, sollten diese Änderungen auch in der Dokumentation erscheinen, die Kunden sehen. Andernfalls folgen Kunden womöglich weiter veralteten Schritten in einem PDF oder einem Help-Center-Artikel.

Um das zu vermeiden, veröffentlichen Sie direkt aus dem Dokument, das Ihr Team pflegt, und teilen Sie einen Live-Link mit Kunden. So spiegeln sich Updates am Quelldokument in der veröffentlichten Version wider, ohne dass Sie mehrere Kopien aktualisieren müssen.

In Slite geht das zum Beispiel über die Option Share to web. Wenn Sie das Originaldokument aktualisieren, übernimmt die veröffentlichte Seite diese Änderungen, sodass Kunden, die den Link öffnen, die neuesten Anleitungen sehen. PDFs oder Screenshots, die sie gespeichert haben, aktualisieren sich allerdings nicht automatisch.

Denselben Ansatz nutzen wir für das Help Center von Slite. Unser Team schreibt und pflegt Hilfeartikel in Slite und veröffentlicht sie dann auf unserer Website.

Änderungen an der Quelle können sofort auf der öffentlichen Seite sichtbar werden. Für Änderungen mit großer Tragweite empfehlen wir einen Prüfprozess:

• Bereiten Sie überarbeitete Anleitungen in einem privaten Entwurf vor, wenn die Änderungen Sicherheit, Abrechnung, Kontoeinrichtung oder einen anderen kritischen Workflow betreffen.
• Lassen Sie die Änderungen von der zuständigen Dokumentverantwortlichen oder dem zuständigen Dokumentverantwortlichen prüfen und freigeben, bevor Sie das öffentlich geteilte Dokument aktualisieren.
• Prüfen Sie häufig geänderte Dokumente nach einem festen Zeitplan, auch wenn niemand einen Fehler gemeldet hat.

Für die laufende Pflege kann Slite Agent Ihrem Team helfen, veraltete Informationen zu erkennen, indem er die Dokumentation mit verbundenen Quellen abgleicht und mögliche Ungenauigkeiten markiert. Dokumentverantwortliche können seine Ergebnisse dann prüfen und vorgeschlagene Änderungen freigeben, bevor die veröffentlichten Anleitungen aktualisiert werden.

Richten Sie den externen Zugriff ein und prüfen Sie ihn

Wenn Sie entschieden haben, was veröffentlicht wird und wer es sehen soll, konfigurieren Sie die Freigabeeinstellungen in Ihrer Dokumentationsplattform. Je nach Tool können Sie einen öffentlichen Link teilen oder bestimmte Personen einladen, mit separaten Einstellungen für Bearbeitung, verschachtelte Seiten und Sichtbarkeit in der Suche. Für eine öffentliche Dokumentationsseite im eigenen Branding prüfen Sie außerdem, ob die Plattform eine eigene Domain und Workspace-Branding unterstützt.

In Slite öffnen Sie zum Beispiel das Dokument und wählen Share. Sie können bestimmte Kunden, Partner oder Auftragnehmer zur Zusammenarbeit einladen oder das Dokument mit Share to web öffentlich veröffentlichen. Wenn Sie die öffentliche Option wählen, prüfen Sie diese Einstellungen, bevor Sie den Link kopieren:

• Wer Zugriff hat: Wählen Sie unter Anyone with the link, ob Besucher die Seite ansehen oder bearbeiten dürfen. Für veröffentlichte Anleitungen ist Nur-Lesen-Zugriff in der Regel angemessen. Das Deaktivieren der Suchmaschinenindexierung macht den Link nicht privat, nutzen Sie also Einladungen, wenn der Zugriff eingeschränkt werden muss.
• Was sonst enthalten ist: Prüfen Sie Include sub-docs, denn wenn diese Option aktiv ist, werden auch verschachtelte Seiten über die öffentliche Seite zugänglich. Sehen Sie sich diese Seiten an, bevor Sie sie aktivieren.
• Wie Besucher Antworten finden: Aktivieren Sie Search engine indexing, wenn Suchmaschinen die Seite finden sollen. Sie können auch die KI-gestützte Suche (Ask) aktivieren, damit Besucher Fragen zur veröffentlichten Dokumentation stellen können, ohne auf private Workspace-Dokumente zuzugreifen.
• Ob Besucher die Seite duplizieren dürfen: Show duplication button steuert, ob Besucher das Dokument in ihr eigenes Slite-Konto kopieren können.

Prüfen Sie vor dem Teilen des Dokuments die Erfahrung von außerhalb Ihres Workspace. Öffnen Sie bei einer öffentlichen Seite den Link in einem nicht angemeldeten Browserfenster; bei eingeladenen Mitwirkenden bestätigen Sie, worauf ihr Konto zugreifen kann:

• Lesen Sie es als externer Besucher: Stellen Sie sicher, dass die Anleitungen ohne Zugriff auf Ihren internen Workspace verständlich sind, und testen Sie Links zu Anhängen und verwandten Seiten.
• Prüfen Sie, was zugänglich ist: Bestätigen Sie, dass nur freigegebene Unterdokumente und Dateien verfügbar sind und Leser nicht auf internes Material geleitet werden, das sie nicht öffnen können.
• Testen Sie die optionalen Funktionen: Wenn das öffentliche Ask aktiviert ist, stellen Sie eine typische Kundenfrage und prüfen Sie die Antwort. Bestätigen Sie außerdem, dass der Duplizieren-Button wie vorgesehen erscheint oder verborgen bleibt.

Wiederholen Sie diese Prüfungen, wenn sich Berechtigungen ändern, Sie Unterdokumente hinzufügen oder öffentliche Anleitungen wesentlich aktualisieren. In Slite können Workspace-Admins zudem prüfen, welche Seiten öffentlich geteilt sind und wer sie veröffentlichen darf.

Wann brauchen Sie spezialisierte Software für öffentliche Dokumentation?

Für die meisten Kundenanleitungen und Partnerressourcen reicht Ihre bestehende Wissensdatenbank möglicherweise aus. Je nachdem, was Sie veröffentlichen und wie Leser es nutzen müssen, brauchen Sie aber eventuell zusätzliche Tools. Dazu gehören:

Helpdesk-Software

Manchmal folgt ein Kunde einer Anleitung zur Fehlerbehebung und kann das Problem trotzdem nicht lösen. Er muss ein Support-Ticket einreichen und einen Mitarbeitenden erreichen.

Helpdesk-Software übernimmt in der Regel Ticketannahme, Weiterleitung und Eskalation. Manche Tools unterstützen auch die Ticketvermeidung, indem sie hilfreiche Artikel vorschlagen, bevor ein Kunde eine Anfrage abschickt.

Zendesk kann zum Beispiel passende Artikel aus einer Wissensdatenbank für den Kundenservice vorschlagen, bevor jemand ein Ticket einreicht, während Intercom Feedback zu Artikeln sammeln kann, damit Ihr Team Anleitungen erkennt, die die Fragen der Leser nicht lösen.

Mit Slite kann auch Ihre interne Wissensdatenbank diesen Workflow unterstützen. Wenn Ihr Team Intercom oder Zendesk nutzt, gibt die Chrome-Erweiterung von Slite Agent Support-Mitarbeitenden Zugriff auf relevantes internes Wissen, während sie Kundenanfragen bearbeiten. Sie nutzt den Kontext des Gesprächs oder Tickets zusammen mit den verbundenen Wissensquellen, um eine Antwort vorzuschlagen, die Mitarbeitende vor dem Senden prüfen können.

Software für versionierte API-Dokumentation

Softwareunternehmen unterstützen oft mehrere API-Versionen gleichzeitig, weil nicht jeder Kunde migrieren kann, sobald eine neue Version erscheint. Wer noch eine ältere Version nutzt, braucht Anleitungen, die zu seiner Integration passen, auch nachdem die neueste Version veröffentlicht ist.

Spezialisierte Software für API-Dokumentation kann Teams helfen bei:

• Versionierten Referenzen: Dokumentation für verschiedene unterstützte API-Versionen pflegen.
• Aus OpenAPI generierter Dokumentation: API-Referenzen aus Spezifikationen erzeugen und mit Änderungen an der API abgleichen.
• Interaktiven API-Playgrounds: Entwicklern erlauben, Anfragen direkt aus der Dokumentation zu testen und Antworten zu prüfen.

Bei Slite nutzen wir zum Beispiel Mintlify für unsere API-Referenz, weil es für versionierte, entwicklerorientierte Dokumentation gebaut ist.

Dokumentationsportale für Kunden und Partner

Wenn Ihr Unternehmen mit Dutzenden von Kunden oder Partnern arbeitet, jeder mit eigenen Onboarding-Anleitungen, Implementierungsanweisungen und Projektdokumentation, wird die Zugriffsverwaltung über einzelne Einladungen irgendwann schwierig, je mehr Organisationen und Nutzer hinzukommen.

Ein dediziertes Dokumentationsportal für Kunden oder Partner hilft Ihnen, den Zugriff im großen Maßstab zu verwalten: über Single Sign-on, gruppenbasierte Berechtigungen und Einstellungen, die festlegen, welche Ressourcen jede Organisation sehen kann. Jeder Kunde oder Partner kann dann auf die für ihn bestimmte Dokumentation zugreifen, ohne die Informationen einer anderen Organisation zu sehen.

Machen Sie externe Dokumentation zu einer Erweiterung Ihrer Wissensdatenbank

Sie können hilfreiche Dokumentation teilen, ohne einen weiteren Satz Dateien zu erzeugen, den Ihr Team bei jeder Produkt- oder Prozessänderung aktualisieren muss. Beginnen Sie mit dem Wissen, das Sie bereits pflegen, und legen Sie dann fest, welche Informationen jede Zielgruppe sehen darf.

Mit Slite können Sie:

• Ausgewählte Workspace-Dokumente im Web veröffentlichen, mit separaten Einstellungen für Suchmaschinenindexierung, einbezogene Unterdokumente und Duplizieren.
• Kunden, Partner oder Auftragnehmer zu bestimmten Dokumenten oder Channels einladen, mit Leser- oder Autorenrechten.
• Externe Leser auf der aktuellen Version halten, während Ihr Team ein geteiltes Dokument aktualisiert, ohne jedes Mal eine neue Datei zu verteilen.
• Dokumentverantwortliche festlegen, Verifizierungen planen und Slite Agent einsetzen, um veraltete oder widersprüchliche Informationen für eine menschliche Prüfung zu untersuchen.
• KI-gestützte Suche über die Inhalte anbieten, die Sie für externe Leser veröffentlichen.

Wenn Sie Produktanleitungen, Onboarding-Material oder Partnerdokumentation teilen möchten, buchen Sie eine Demo. Wir zeigen Ihnen, wie Sie die richtigen Dokumente veröffentlichen, den externen Zugriff steuern und die Informationen aktuell halten.

FAQ

Was bedeutet „öffentlich" bei Dokumentation?

Öffentliche Dokumentation sind Informationen, die Personen außerhalb einer Organisation zur Verfügung gestellt werden. Sie kann für alle offen sein oder nur mit bestimmten externen Lesern geteilt werden.

Was sind kundenorientierte Dokumente?

Kundenorientierte Dokumente umfassen Onboarding-Anleitungen, Produktanleitungen, Integrationsreferenzen, FAQs und Artikel zur Fehlerbehebung, die Kunden helfen, ein Produkt zu bewerten, einzurichten und zu nutzen.

Brauchen öffentliche Dokumentationsseiten eine eigene Domain?

Nein. Öffentliche Dokumente können die Standard-URL der Dokumentationsplattform nutzen. Eine eigene Domain ist optional; Slite unterstützt sie in den dafür vorgesehenen Tarifen, zusammen mit Branding-Optionen für öffentliche Seiten.

Können KI-Tools und Suchmaschinen öffentliche Dokumentation nutzen?

Das ist möglich, abhängig von den öffentlichen Einstellungen des Dokuments und dem Verhalten des jeweiligen Crawlers oder Tools. Slite hat separate Einstellungen für Suchmaschinenindexierung und KI-gestützte Suche bei öffentlichen Dokumenten. Die öffentlichen KI-Antworten nutzen die Inhalte, die für externe Leser veröffentlicht wurden.