Lesepfad für Dokumentations-Websites
Die Reihenfolge, in der ein Dokumentationsteam seine Website kennenlernt. Jeder Schritt nennt, wer die Seite lesen sollte.
Die erste Woche: sicher schreiben und veröffentlichen
| Nr. | Lesen Sie | Wer | Warum |
|---|---|---|---|
| 1 | Dokumentations-Websites: hier beginnen | Alle | Wie Dokumentation mit Exponential läuft |
| 2 | Im Editor anmelden | Autoren | Wo man sich anmeldet |
| 3 | Inhalte bearbeiten | Autoren | Seiten anlegen und ändern |
| 4 | Veröffentlichen und Versionen | Autoren | Entwürfe, Versionen und zurückgehen |
| 5 | Medien und Uploads | Autoren | Screenshots und Dateien |
| 6 | Rollen für Ihr Team | Dokumentationsleitung | Autoren und Freigebende |
Der erste Monat: Struktur, Prüfung und Suche
| Nr. | Lesen Sie | Wer | Warum |
|---|---|---|---|
| 7 | Freigabe und Prüfung | Dokumentationsleitung | Prüfung vor der Freigabe |
| 8 | Objektzustände | Dokumentationsleitung | Ein Freigabezustand, getrennt vom Veröffentlichen |
| 9 | Den Inhaltsbaum strukturieren | Dokumentationsleitung | Eine Hierarchie, die wachsen kann |
| 10 | Suchen | Alle | Wie Redakteure Seiten finden |
| 11 | Website-Suche und wonach Besucher suchen | Dokumentationsleitung | Fehlende Seiten und fehlende Wörter |
| 12 | URLs, Weiterleitungen und verschobene Seiten | Autoren | Lesezeichen, die weiter funktionieren |
| 13 | Richtlinien für Bilder und Dateien | Autoren | Screenshots, die lesbar und beschrieben sind |
Das erste Quartal: Sprachen, Exporte und Pflege
| Nr. | Lesen Sie | Wer | Warum |
|---|---|---|---|
| 14 | Übersetzungsroutine | Dokumentationsleitung | Übersetzungen, die Schritt halten |
| 15 | PDF-Export | Dokumentationsleitung | Druckbare Handbücher |
| 16 | Hilfe als Inhalt gepflegt | Dokumentationsleitung | Ein Modell für Thementypen, Zustände und E-Books |
| 17 | Inhalts-Audits | Dokumentationsleitung | Seiten, die noch stimmen |
| 18 | Barrierefreiheit pflegen | Autoren | Dokumentation, die alle nutzen können |
| 19 | Die REST-API für Betreiber | Produktverantwortliche | Dokumentation in Ihrem Produkt oder Ihrer App |
| 20 | Wie Updates funktionieren | Produktverantwortliche | Upgrades mit Ihrem Anbieter |
| 21 | Funktionen, die Kunden oft übersehen | Alle | Was die Website bereits kann |
Wenn Sie nur eine Stunde haben
Lesen Sie die Schritte 1, 4, 7 und 11: das Modell, Versionen, Prüfung und was Leser nicht finden.
Verwandte Seiten
- Dokumentations-Websites: hier beginnen
- Lesepfad für Kunden
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.