Benutzerdefinierte Domain für die Dokumentation: Einrichtung von docs.yourcompany.com
docs.yourcompany.com wirkt professioneller als docsbook.io/yourorg/yourrepo. Sie ist außerdem relevant für SEO, Vertrauen und den ersten Eindruck („Ist das ein echtes Produkt?“). So richten Sie sie korrekt ein.
Kurzfassung#
- Entscheide dich für eine Subdomain (
docs.yourcompany.com) oder ein Unterverzeichnis (yourcompany.com/docs/) - Füge in DNS einen CNAME- oder A-Eintrag hinzu, der auf deinen Dokumentationshost verweist
- Warte, bis SSL bereitgestellt wurde (normalerweise weniger als 5 Minuten)
- Richte Weiterleitungen von jeder vorherigen URL ein
- Aktualisiere interne Links und externe Verweise
Subdomain vs. Unterverzeichnis#
Die SEO-Debatte ist real. Beide funktionieren 2026, haben aber unterschiedliche Vor- und Nachteile.
Subdomain (docs.yourcompany.com) |
Unterverzeichnis (yourcompany.com/docs/) |
|
|---|---|---|
| Komplexität der Einrichtung | Einfacher (ein DNS-Eintrag) | Schwieriger (Reverse-Proxy oder gemeinsam genutzte Plattform) |
| SEO-Autorität | Größtenteils von der Root-Domain übernommen | Vollständig übernommen |
| Flexibilität beim Hosting | Unabhängig von der Hauptseite | Nutzt die Infrastruktur der Hauptseite gemeinsam |
| Markenkohärenz | Klare Trennung | Eng gekoppelt |
| Verbreitet im Jahr 2026 | Die meisten Dokumentationsseiten | Stripe, GitHub, AWS |
Für die meisten Teams ist die Subdomain einfacher, und der SEO-Unterschied ist gering. Verwende nur dann ein Unterverzeichnis, wenn deine Hauptseite auf einer Plattform läuft, die Reverse-Proxying für Dokumentationen sauber unterstützt.
Einrichten der Subdomain (Docsbook-Beispiel)#
Drei Schritte:
1. Im Docsbook-Dashboard#
- Öffnen Sie Ihre Workspace-Einstellungen
- Einstellungen → Domain
- Geben Sie
docs.yourcompany.comein - Klicken Sie auf „Speichern“
Das Dashboard zeigt die DNS-Einträge an, die Sie hinzufügen müssen.
2. Bei Ihrem DNS-Anbieter#
Fügen Sie einen CNAME-Eintrag hinzu:
Type: CNAME
Name: docs
Value: cname.vercel-dns.com
TTL: 300 (or default)
Wenn Ihr DNS-Anbieter keinen CNAME-Eintrag am Root unterstützt (Cloudflares Flattening oder Ähnliches), verwenden Sie die von Ihrer Plattform bereitgestellte Alternative mit einem A-Eintrag.
3. SSL#
SSL ist automatisch. Docsbook (über Vercel) stellt innerhalb von 5 Minuten ein Let's-Encrypt-Zertifikat bereit. Im Dashboard wird der Status „Aktiv“ angezeigt.
Gesamtdauer: normalerweise 5–15 Minuten einschließlich der DNS-Propagation.
Wenn SSL länger dauert#
Wenn SSL nach 30 Minuten weiterhin „Pending“ ist:
- Überprüfen Sie, ob DNS weltweit propagiert wurde:
dig docs.yourcompany.comsollte zum CNAME-Ziel aufgelöst werden - Entfernen Sie alle CAA-Einträge, die Let's Encrypt blockieren
- Überprüfen Sie, ob Ihre Domain nicht bereits HTTPS über einen anderen Anbieter bereitstellt
Weiterleitungen#
Wenn Sie Ihre Dokumentation zuvor unter einer anderen URL gehostet haben, richten Sie 301-Weiterleitungen ein, um die SEO zu erhalten.
Von einem Docs-Unterverzeichnis zur neuen Subdomain#
yourcompany.com/docs/* → docs.yourcompany.com/* (301)
Die meisten Plattformen unterstützen dies über Weiterleitungsregeln.
Von GitBook-v-Pfaden zu Docsbook#
GitBook-URLs weisen typischerweise /v/1.0/-Muster auf:
docs.yourcompany.com/v/1.0/api/auth → docs.yourcompany.com/api/auth (301)
Wenn Sie Cloudflare vor Ihrer Domain verwenden, können Sie dies mit einer einzigen Seitenregel erledigen. Siehe Migration von GitBook zu Docsbook.
Vom Docusaurus-Präfix zum Stammverzeichnis#
Docusaurus verwendet häufig /docs/intro-Pfade. Wenn du sie auf das Stammverzeichnis abflachst:
docs.yourcompany.com/docs/* → docs.yourcompany.com/* (301)
Siehe Migration von Docusaurus zu Docsbook.
SEO-Überlegungen#
Drei Dinge, die nach der Umstellung überprüft werden sollten:
Search Console#
Fügen Sie die neue Domain zur Google Search Console hinzu. Reichen Sie die Sitemap ein (Docsbook generiert /sitemap.xml automatisch). Überprüfen Sie den Indexierungsbericht 4–6 Wochen lang.
Canonical-Tags#
Wenn Sie die alte URL aus irgendeinem Grund als Fallback aktiv lassen, setzen Sie auf der alten URL Canonical-Tags, die auf die neue verweisen. Eine 301-Weiterleitung ist noch besser, da sie sowohl Leser als auch Rankingsignale weiterleitet.
llms.txt Verbreitung#
Wenn Sie die Domain wechseln, müssen KI-Agenten Ihre llms.txt erneut entdecken. Dies geschieht normalerweise innerhalb weniger Crawls. Überprüfen Sie:
curl https://docs.yourcompany.com/llms.txt | head -10Siehe den vollständigen llms.txt-Leitfaden.
Welche Änderungen gibt es für Nutzer#
- Lesezeichen für alte URLs: durch Weiterleitungen abgedeckt
- Gespeicherte Support-Antworten: aktualisieren
- Interne Produktlinks: aktualisieren
- Externe Backlinks: bleiben bestehen (die 301-Weiterleitung überträgt die Autorität)
Die für Nutzer sichtbare Erfahrung sollte sich über die URL hinaus nicht ändern.
Unterstützung benutzerdefinierter Domains nach Plattform#
| Plattform | Benutzerdefinierte Domain unterstützt | Kosten |
|---|---|---|
| Docsbook | Ja, mit automatischem SSL | Nichts — die Domain belastet das Projektguthaben nicht; siehe docsbook.io/pricing |
| Mintlify | Ja | Mit einem kostenpflichtigen Tarif — siehe mintlify.com/pricing |
| GitBook | Ja | Mit einem kostenpflichtigen Tarif — siehe gitbook.com/pricing |
| ReadMe | Ja | Mit einem kostenpflichtigen Tarif — siehe readme.com/pricing |
| GitHub Pages | Ja | Kostenlos |
| Vercel / Netlify | Ja | Kostenloser Tarif mit Domainlimits pro Konto |
Die Preise in dieser Kategorie ändern sich; die jeweilige Preisseite des Anbieters ist die einzige verlässliche Quelle, und diese Tabelle verlinkt auf alle, statt Zahlen erneut anzugeben, die schnell veralten.
Häufige Fehler#
- Die Apex-Domain auf einen CNAME zeigen lassen — die meisten DNS-Anbieter erlauben dies nicht; verwenden Sie eine Subdomain (
docs.) oder einen abgeflachten A-Record - Vergessen weiterzuleiten — alte URLs 404 → SEO-Ranking sinkt → Verlust von Autorität
- HTTPS nicht erzwungen — einige Plattformen stellen sowohl HTTP als auch HTTPS bereit; erzwingen Sie eine Weiterleitung zu HTTPS
- Mehrere
docs-Subdomains — immer nur ein CNAME gleichzeitig, entfernen Sie zuerst die alten
Weiterführende Lektüre#
- Von GitBook zu Docsbook migrieren
- Von Docusaurus zu Docsbook migrieren
- SEO-Leitfaden für Dokumentationen
Docsbook hostet docs.yourcompany.com mit automatischem SSL, und die Domain belastet dein Projektguthaben nicht.