Wie veröffentliche ich Release Notes und Changelogs?

Vorab prüfen

• Diese Funktion ist für Hilfe-Center- und Produktdokumentations-Websites gedacht. Sie ist standardmäßig aktiv, wenn Sie mit der Vorlage Software oder SaaS gestartet sind. Bei anderen Website-Typen lässt sie sich nicht aktivieren.
• Sie benötigen die Berechtigung, das Hilfe-Center zu verwalten.

Schritt für Schritt

1. Öffnen Sie Beiträge und wählen Sie Versionshinweise. Dadurch öffnet sich die Liste der Release Notes.
2. Wählen Sie Neu.
3. Füllen Sie Titel, version und releasedOn aus, also das Datum, an dem die Version erschienen ist. Diese drei Angaben sind Pflichtfelder.
4. Optional: Zusammenfassung, bis zu 1.000 Zeichen lang, und Link zu einer ausführlicheren Seite.
5. Fügen Sie für jede Änderung eine Zeile im Listenfeld hinzu. In diesem Formular heißt diese Liste Momente. Wählen Sie den passenden Art: Neu, Verbessert oder Behoben. Verfassen Sie den Text mit bis zu 300 Zeichen. Sie können bis zu 100 Zeilen hinzufügen.
6. Weisen Sie den Eintrag dem Bereich des passenden Hubs zu und veröffentlichen Sie ihn anschließend.

Das Formular zeigt diese Support-Felder unter ihren Kurzbezeichnungen an, wie etwa version und releasedOn, statt in ganzen Sätzen.

Gut zu wissen

• Reihenfolge. Einträge werden nach dem neuesten Veröffentlichungsdatum sortiert ganz oben aufgeführt.
• Pro Hub. Die Seite eines Hubs listet die Notizen aus dem jeweiligen Bereich und den eigenen Themen auf.
• RSS. Leser können den Changelog als Feed abonnieren. Der Feed liegt auf Ihrer Website unter der Adresse mit der Endung /help/release-notes.rss.
• Suchdaten. Jeder Eintrag wird für Suchmaschinen als technischer Artikel samt Versionsnummer ausgewiesen. Eine besondere Darstellung in den Suchergebnissen ist damit jedoch nicht garantiert.
• Für Leser schreiben. Erklären Sie in einfachen Worten, was sich für die Nutzer konkret geändert hat.

Fragen

Ähnliche Themen

• Bekannte Probleme und Hinweise
• Hilfe-Hubs
• Hilfecenter und Produktdoku
• Jobs, Events & mehr