Buuk ist Hilfezentrum-Infrastruktur mit einem redaktionellen Gate. Inhalte leben in einem Workspace. Editoren entwerfen, organisieren und prüfen. Kunden sehen nur veröffentlichte Seiten auf der öffentlichen Site, in der Suche, in Ask AI und im Widget.
1. Ein Workspace ist die Einheit der Docs
Jeder Workspace hat einen Namen, einen Slug, Branding, Mitglieder und Collections. Die öffentliche URL sieht aus wie app.getbuuk.com/help/your-slug. Auf Growth kannst du einen eigenen Hostnamen wie docs.yourproduct.com anhängen.
Owner und Editoren können veröffentlichen. Viewer können Entwürfe im Dashboard lesen, ohne Live-Seiten zu ändern.
2. Collections strukturieren die öffentliche Site
Eine vollständige Docs-Site (diese hier) schaltet fünf Collections ein. Eine Teilmenge kannst du unter Customise → site profile aktivieren.
| Collection | Editor-Start | Öffentlicher Tab |
|---|---|---|
| Dokumentation | Articles | Help |
| FAQ | FAQ | FAQ |
| Guides | Docs → Guides | Guides |
| API-Referenz | Docs → API Reference | API Reference |
| Changelog | Docs → Changelog | Changelog |
Sections und Ordner liegen unter einer Collection. Blattartikel sind Seiten. Ordner sind in der Sidebar einklappbar, damit eine lange Navigation scannbar bleibt.
3. Entwerfen, Vorschau, dann veröffentlichen
- Artikel anlegen oder importieren. Speichern ist automatisch. Die Versionshistorie behält frühere Stände.
- Das öffentliche Layout über Help center preview prüfen. Vorschau macht einen Entwurf nicht öffentlich.
- Veröffentlichen, wenn der Text bereit ist. Die URL bleibt stabil, solange der Slug sich nicht ändert.
- Optional: einen Veröffentlichungszeitpunkt planen oder vor dem Ship eine redaktionelle Freigabe verlangen.
Unveröffentlichte Arbeit ist nicht in der öffentlichen Suche, im Widget und in Ask AI für Leser. Behandle Entwürfe als intern, bis du veröffentlichst.
4. KI ist Schreibhilfe, nicht der Publisher
Ask Buuk im Dashboard kann einen Artikel entwerfen, einen Abschnitt umschreiben oder dich zu Einstellungen führen. Vorgeschlagene Updates machen Tickets, Slack-Threads, GitHub-Releases, Linear-Issues, verpasste Suchen und „nicht hilfreich“-Feedback zu einer Review-Liste.
Accept wendet an oder öffnet einen Entwurf. Bearbeite, bevor du veröffentlichst. Dismiss, wenn die Docs schon stimmen. Buuk veröffentlicht niemals selbst eine Suggestion.
5. Das öffentliche Hilfezentrum ist die Kundenoberfläche
- Suche über veröffentlichte Artikel
- Optionale KI-Antworten mit Quellenangaben aus diesen Artikeln
- Hilfreich / nicht hilfreich auf jeder Seite
- Changelog-Reaktionen und Kommentare (kein Buuk-Login nötig)
- Optionales einbettbares Widget mit Suche, Chat, Ankündigungen und Stimme
6. Analytics schließt die Schleife
Reporting zeigt Views und Suchen. Verpasste Suchen und unbeantwortete Ask-AI-Fragen werden zu vorgeschlagenen Updates. Doc health und Freshness markieren dünne, veraltete oder unbestätigte Seiten, damit du weißt, was als Nächstes umgeschrieben werden muss.
Eine typische Woche
- Produkt shippen — Die App ändert sich. GitHub-Releases, Tickets und Slack-Fragen kommen wie gewohnt.
- Suggestions prüfen — Öffne Suggestions. Übernimm, was Docs werden soll. Lass den Rest.
- Bearbeiten und veröffentlichen — Im Editor umschreiben. Preview prüfen. Veröffentlichen. Freshness und Suche fangen, was du übersehen hast.
Du siehst diese Schleife auf Buuk selbst. Öffne einen beliebigen Artikel unter Articles im Dashboard, um diesen Text zu bearbeiten.