Hoe publiceer ik release notes en een changelog voor mijn product?

Voordat je begint

• Deze functie is gemaakt voor Help Center- en Product Docs-sites. Het staat standaard aan voor het startpunt Software of SaaS. Een ander type site kan dit niet toevoegen.
• U hebt toestemming nodig om het helpcentrum te beheren.

Stappenplan

1. Open Verhalen en kies Releasenotes. Hiermee opent u de lijst met release notes.
2. Kies Nieuw.
3. Vul Titel, version en releasedOn in, de datum waarop de versie uitkwam. Deze drie zijn verplicht.
4. Optioneel: Samenvatting, maximaal 1.000 tekens, en Link naar een langere pagina.
5. Voeg één regel toe voor elke wijziging in het lijstveld. In dit formulier wordt die lijst getoond als Momenten. Kies het bijbehorende Type: Nieuw, Verbeterd of Opgelost. Schrijf de tekst in maximaal 300 tekens. U kunt maximaal 100 regels toevoegen.
6. Plaats de note in de sectie van de juiste hub en publiceer vervolgens.

Het formulier toont deze ondersteunende velden met hun korte namen, zoals version en releasedOn, in plaats van volledige zinnen.

Goed om te weten

• Volgorde. Notes worden gesorteerd met de nieuwste releasedatum eerst.
• Per hub. De pagina van een hub toont de notes van de eigen sectie en onderwerpen.
• RSS. Lezers kunnen de changelog volgen als feed. De feed staat op het adres dat eindigt op /help/release-notes.rss op uw site.
• Zoekgegevens. Elke note wordt bij zoekmachines beschreven als een technisch artikel met de bijbehorende versie. Niets garandeert een speciale weergave in zoekresultaten.
• Schrijf voor uw lezer. Vertel in duidelijke woorden wat er voor hen is veranderd.

Vragen

Gerelateerd

• Bekende problemen en meldingen
• Help-hubs
• Helpcentrum en documentatie
• Vacatures, evenementen en meer