Poznámky k vydaniu a changelog

Poznámky k vydaniu sú datovaný prvostranný záznam o zmene produktu: čo bolo vydané, koho sa to týka, čo sa správa inak a čo musí používateľ urobiť ďalej. Changelog je chronologická kolekcia týchto záznamov. Tento formát je nástrojom na udržanie si zákazníkov skôr, než aktívom na získavanie návštevnosti; zákazníci ho používajú na plánovanie práce a vyhýbanie sa prekvapeniam.

Hlavným pravidlom je dôsledok pred oslavou. Vydanie môže byť pre tím vzrušujúce, ale čitateľ najskôr potrebuje vedieť, či sa zmenil jeho pracovný postup, integrácia, dáta, oprávnenia, cena alebo kompatibilita. Uveďte tento dôsledok v jednoduchom jazyku, potom vysvetlite schopnosť. V rámci systému SEO typov príspevkov sú poznámky k vydaniu podporným obsahom v štádiu retencie; ich hodnota pochádza z trvalých záznamov, ktoré nie sú nikdy ticho prepísané.

Aké otázky zodpovedá

Kompletný záznam poznámok k vydaniu odpovedá na otázky, ktoré si súčasný používateľ kladie po tom, čo uvidí zmenu produktu alebo narazí na neznáme správanie:

• Čo sa zmenilo a k akému dátumu vydania alebo v ktorej verzii?
• Je zmena dostupná teraz, zavádza sa postupne, je v beta verzii, alebo obmedzená podľa plánu, regiónu, platformy alebo typu účtu?
• Koho sa to týka – administrátorov, koncových používateľov, vývojárov, partnerov alebo definovanej integrácie?
• Aké bolo predchádzajúce správanie a čo je teraz inak?
• Potrebuje používateľ migrovať, aktualizovať nastavenia, znova autorizovať prístup, preškoliť kolegov, alebo nemusí robiť nič?
• Je zmena zásadná, zastaraná, reverzibilná, bezpečnostne citlivá alebo pravdepodobne zmení uložené dáta?
• Kde sú aktualizované pokyny, technická referencia, známe obmedzenia a možnosť podpory?
• Ako môže čitateľ overiť, že nové správanie je aktívne v jeho účte?

Nenúťte čitateľov odvodzovať dopad z označení ako „vylepšené", „aktualizované" alebo „zjednodušené". „Exporty sú vylepšené" je propagačné, ale neoveriteľné. „CSV exporty teraz obsahujú použité krajiny a modelové filtre v dvoch nových stĺpcoch; existujúce stĺpce a poradie zostávajú nezmenené" definuje pozorovateľnú zmenu a jej hranicu kompatibility.

Kedy použiť tento typ príspevku

Použite poznámky k vydaniu, keď udalosť bola vydaná alebo má pevný stav dostupnosti a vytvára používateľsky viditeľný rozdiel, ktorý stojí za zachovanie v histórii produktu. Vyhľadávací zámer je zvyčajne navigačný alebo informačný: čitatelia vyhľadávajú produkt plus „poznámky k vydaniu", číslo verzie, zmenenú funkciu, zastaranú funkciu alebo neznámy názov rozhrania. Nepoužívajte tento formát ako sľubník backlogu, všeobecný informačný kanál alebo náhradu za dokumentáciu úloh.

Zmena nepotrebuje nové rozhranie, aby bola oprávnená. Správanie API, uchovávanie, výpočty, autentifikácia, formáty, limity, predvolené hodnoty, fakturácia a prístupnosť – to všetko môže vyžadovať záznam. Interný refaktoring bez pozorovateľného dôsledku nie.

Najvhodnejšie pre tieto typy podnikov

Poradie odráža potrebu udržiavať datovanú verejnú zmluvu s existujúcimi používateľmi.

1. SaaS . Najsilnejšie zodpovedá, pretože kontinuálne doručované rozhrania, API, oprávnenia, integrácie a limitné plány sa môžu meniť medzi návštevami zákazníkov. Záznamy by mali zahŕňať stav zavádzania, dotknuté plány, vplyv na administrátorov a odkazy na dokumentáciu.
2. Marketplace . Vysoká hodnota, pretože jedno vydanie môže ovplyvniť kupujúcich, predávajúcich, moderátorov, príjemcov platieb alebo partnerov odlišne. Rozdeľte dopad a neprezentujte zmenu špecifickú pre jedného účastníka ako univerzálnu.
3. E-commerce . Užitočné pre zmeny v účte, pokladni, predplatnom, vrátení tovaru, vernosti, doručení a nástrojoch pre predajcov. Oddeľte dopad na zákazníka eshopu od dopadu na operátora alebo integráciu, najmä v oblasti platieb a stavov objednávok.
4. Výrobcovia a priemyselní dodávatelia . Dôležité pre zmeny firmvéru, riadiaceho softvéru, pripojených zariadení, technických portálov a revízií špecifikácií. Verzia, kompatibilita modelov, bezpečnostné hranice a možnosť vrátenia musia byť explicitné.
5. Financie, fintech a poistenie . Hodnotné, ale náročné na kontrolu, pretože zmeny výpočtov, oprávnenosti, zverejňovania, autentifikácie a spracovania údajov môžu mať regulačné dôsledky. Zaznamenajte jurisdikciu, schválenie, dátum účinnosti a nahradené správanie.
6. B2B služby . Selektívne užitočné, keď služba zahŕňa udržiavanú platformu, metodológiu, dátovú sadu, klientský portál alebo štandardný výstup. Bežné firemné správy patria inde, pokiaľ nemenia zmluvu so zákazníkom alebo jeho pracovný postup.

Vyhľadávací zámer

Dopyt po poznámkach k vydaniu je často nízkoobjemový a vysoko špecifický. Dopyty zahŕňajú názov produktu so slovami „changelog", „najnovšia verzia", „čo sa zmenilo", „nový dashboard", verziu API, chybu zavedenú po aktualizácii alebo dátum zastarania. Hľadajúci nežiada o širokú prezentáciu produktu. Chce autoritatívnu časovú pečiatku a dostatok detailov na rozhodnutie.

Užitočný výsledok začína produkt + verzia alebo dátum + zmena + dopad. Uveďte tieto fakty v názve, úvodnom zhrnutí, nadpisoch a metadátach bez toho, aby ste nútene umiestňovali každý drobný záznam na samostatnú indexovateľnú URL. Stabilné kotvy umožňujú tímom podpory a AI odpovediam citovať jeden záznam; samostatné stránky sú opodstatnené, keď má vydanie rozsiahlu migráciu, špecifický dopyt alebo niekoľko súvisiacich zmien.

Poznámky k vydaniu sú podceňovaným signálom aktuálnosti, pretože odhaľujú skutočnú zmenu v tempe, v akom nastáva. To neospravedlňuje menenie dátumov, aby ste pôsobili aktívne. Dátum záznamu, aktuálna dokumentácia, správanie produktu a migračné usmernenia musia byť v súlade.

Štruktúra stránky

Rozsahy slov určujú dôraz, nie kvóty. Zachovajte rovnaké poradie polí, aby čitatelia mohli prehľadávať malé opravy aj zásadné vydania rovnako.

Zoskupujte zmeny so stabilnými označeniami ako Pridané, Zmenené, Opravené, Zastarané, Odstránené, Bezpečnosť, ale nikdy nenechajte označenie nahradiť vysvetlenie. „Opravené: exporty" nie je užitočný záznam. Každá položka musí uvádzať predchádzajúci príznak alebo obmedzenie, nový pozorovateľný stav, dotknutý rozsah a prípadnú požadovanú akciu.

Vyžadované prvky

Umiestnenie je súčasťou riadenia rizika: varovanie o migrácii zobrazené až po oslave funkcie prichádza príliš neskoro.

Frontmatter a štruktúrované údaje

Postupujte podľa špecifikácie frontmatter . Táto playbook stránka používa entity = "post-type-release-notes". Produkovaný changelog by mal používať stabilnú hodnotu produktu a streamu, napríklad entity = "atlas-cloud-release-notes"; jednotlivé vydanie môže použiť entity = "atlas-cloud-2026-08". Nepoužívajte slogan kampane alebo premenlivý názov vydania ako identifikátor.

Použite schemaType = "Article" pre jednotlivú stránku poznámok k vydaniu. Ak stránka vystavuje index ako samostatnú entitu, CollectionPage môže popisovať tento index, pričom každý podstatný záznam zostáva viditeľnou datovanou položkou. Pridajte FAQPage len vtedy, keď je FAQ viditeľné a podporované implementáciou. Nepoužívajte HowTo len preto, že migračné pokyny obsahujú kroky, a neoznačujte produkt ako novovydaný, keď stránka len opravila formuláciu.

Ukladajte dátum vydania oddelene od dátumu publikácie a úpravy. Odporúčané polia zahŕňajú: product, stream, version, status, releasedAt, platforms, plans, regions, affected roles, breakingChange, actionRequired, deprecationDate, owner, canonical URL a documentation targets. Pre postupné zavádzanie uchovajte jeden dátum vydania a uveďte časové okno vo viditeľnom texte.

Úplný príklad

Fiktívny príklad nižšie demonštruje jedno podstatné vydanie. Uchováva dôsledok migrácie pred zhrnutím funkcie a používa stabilnú URL verzie.

+++
title = "Atlas Cloud 4.8 Release Notes — 27 August 2026"
seoTitle = "Atlas Cloud 4.8 Release Notes: Export API Migration"
entity = "atlas-cloud-4-8"
keywords = [ "Atlas Cloud 4.8", "Atlas release notes", "export API v2", "Atlas changelog", "export migration", "Atlas product updates" ]
description = "Atlas Cloud 4.8 adds saved export views and API v2, explains the v1 deprecation deadline, and gives administrators a tested migration and validation path."
type = "academy"
date = "2026-08-27 10:00:00"
schemaType = "Article"
product = "Atlas Cloud"
version = "4.8"
releaseStatus = "rolling-out"
releasedAt = "2026-08-27"
platforms = [ "web", "API" ]
affectedRoles = [ "workspace administrator", "integration owner" ]
breakingChange = true
deprecationDate = "2026-10-15"
+++

# Atlas Cloud 4.8 poznámky k vydaniu

Atlas Cloud 4.8 sa začal zavádzať 27. augusta 2026. Pridáva uložené zobrazenia exportov a Export API v2. Členovia pracovného priestoru môžu používať uložené zobrazenia bez zmeny existujúcich exportov. Vlastníci integrácií používajúcich API v1 musia migrovať do 15. októbra 2026; po tomto dátume budú exportné požiadavky v1 vracať odpoveď o nepodporovanej verzii.

## Vyžadovaná akcia: migrujte Export API v1

**Koho sa to týka:** integrácie, ktoré posielajú požiadavky na `/api/v1/exports`. Dashboardové exporty a API v2 klienti nie sú dotknutí.

**Čo sa mení:** v2 vyžaduje explicitnú hodnotu `format` a vracia identifikátor exportnej úlohy v `data.id`. Stĺpce súborov sa nemenia, pokiaľ uložené zobrazenie nevyberie inú sadu polí.

**Termín:** dokončite migráciu a overenie do 15. októbra 2026. Existujúce požiadavky v1 fungujú až do tohto termínu.

1. Vytvorte testovaciu požiadavku na v2 endpoint s rovnakými filtrami ako aktuálna požiadavka v1.
2. Pridajte požadovanú hodnotu `format` a prečítajte identifikátor úlohy z `data.id`.
3. Porovnajte počet riadkov, sadu polí, časové pásmo a známy záznam medzi starým a novým súborom.
4. Aktualizujte produkčné prostredie až po úspešnom porovnaní. Ponechajte predchádzajúcu konfiguráciu k dispozícii, kým sa nepodarí prvý plánovaný produkčný export.

Ak test nesedí, ponechajte produkčnú integráciu na v1 a pošlite podpore sanitizované ID požiadavky, časovú pečiatku, časové pásmo a nezrovnalosť polí. Nezahŕňajte prístupový token.

## Pridané: uložené zobrazenia exportov

Administrátori pracovného priestoru môžu uložiť pomenovanú sadu polí, filtrov, triedenia a formátu súboru. Členovia s oprávnením na export môžu zobrazenie znovu použiť; uloženie zobrazenia neposkytuje prístup k záznamom, ktoré už predtým nemohli vidieť.

Na overenie dostupnosti otvorte **Exporty → Zobrazenia** a hľadajte **Uložiť aktuálne zobrazenie**. Ovládací prvok sa môže počas zavádzania objaviť až o tri dni. Je súčasťou plánov Standard a Enterprise vo všetkých regiónoch.

## Opravené: označenia krajinových filtrov v CSV súboroch

CSV exporty teraz používajú viditeľný názov krajiny v stĺpci so zhrnutím filtra namiesto interného dvojpísmenového kódu. Mení sa len označenie v zhrnutí; filtrované záznamy a existujúce dátové stĺpce zostávajú nezmenené.

## Známe obmedzenia

Uložené zobrazenia zatiaľ nemožno prenášať medzi pracovnými priestormi. Odstránené pole je odstránené zo zobrazenia pri jeho najbližšom spustení a história exportov zaznamenáva toto vynechanie.

## Aktualizované zdroje

- Migračná príručka pre Export API v2
- Referenčná príručka Export API
- Dokumentácia oprávnení pre export
- Riešenie problémov s exportom

Príklad pomenúva otestovanú hranicu kompatibility, rozlišuje medzi zavádzaním a dátumom vydania a dáva čitateľom spôsob, ako overiť prístup.

Galéria dizajnov

Zachovajte rovnaké fakty o vydaní v každej variante rozloženia, aby dizajnová kontrola testovala hierarchiu, nie rôzne redakčné rozhodnutia.

Kontrolný zoznam kvality

Poznámka k vydaniu je pripravená až vtedy, keď je každé uplatniteľné tvrdenie pravdivé:

• Názov a úvod identifikujú produkt, dátum alebo verziu, hlavnú zmenu a dotknuté publikum.
• Dostupnosť je presná: vydané, zavádzané s časovým oknom, beta, opt-in, obmedzené plánom, obmedzené regiónom, odložené alebo stiahnuté.
• Každý záznam vysvetľuje pozorovateľné správanie pred a po namiesto spoliehania sa na „vylepšené", „vylepšené" alebo „opravené".
• Označenia Pridané, Zmenené, Opravené, Zastarané, Odstránené a Bezpečnosť sú aplikované konzistentne.
• Zásadné zmeny sa objavujú pred propagačnými benefitmi a uvádzajú dotknutý rozsah, termín, spôsob zlyhania, náhradu, migráciu, overenie a možnosť vrátenia alebo podpory.
• Dátumy rozlišujú vydanie, publikáciu, podstatnú úpravu, zastaranie a odstránenie.
• Identifikátory verzií, názvy endpointov, označenia v menu, plány, regióny a rozsah platforiem boli overené oproti vydanému stavu.
• Čitateľ vie rozoznať, či je akcia potrebná a ako potvrdiť jej dokončenie.
• Aktuálna dokumentácia odráža nové správanie a odkazuje späť na príslušné vydanie tam, kde záleží na histórii.
• Snímky obrazovky majú dátum alebo verziu zachytenia a textový ekvivalent ovládacích prvkov alebo stavov, ktoré zobrazujú.
• Archív poskytuje stabilné URL alebo kotvy, prehliadanie od najnovších a spôsob, ako sa dostať k starším záznamom.
• Odpovede FAQ v frontmatter a viditeľné odpovede FAQ sa presne zhodujú a analytika rozlišuje medzi prehliadaním a migráciou alebo produktovou akciou.

Časté chyby

Písanie kampanového textu namiesto záznamu. „Sme nadšení, že môžeme transformovať váš pracovný postup" odkladá fakty. Začnite vydaným správaním, publikom, dostupnosťou a akciou; naratív umiestnite do samostatného oznámenia o spustení.

Zahrabávanie zásadných zmien. Termín migrácie pod snímkami obrazovky a benefitmi vytvára zbytočné zlyhania. Umiestnite varovanie na prvé miesto a urobte ho samostatne zrozumiteľným.

Označovanie zavádzania ako spustenia všade. Ak majú prístup len niektoré účty, povedzte „zavádzanie" a uveďte očakávané časové okno. Používatelia strácajú dôveru, keď pokyny opisujú ovládací prvok, ktorý ešte nevidia.

Používanie „opravy chýb a vylepšenia". To skrýva dotknuté správanie a bráni používateľom rozpoznať, že ich problém bol vyriešený. Pomenujte príznak, rozsah a nový stav, pokiaľ bezpečnostné zverejnenie nevyžaduje zdržanlivosť.

Posúvanie dátumov kvôli aktuálnosti. Oprava preklepu nerobí staré vydanie novým. Zachovajte releasedAt, zaznamenajte podstatnú opravu samostatne a použite lastmod len vtedy, keď sa viditeľný záznam zmysluplne zmenil.

Duplikovanie aktuálnych pokynov. Dlhý postup inštalácie sa na dvoch miestach rozíde. Zhrňte zmenený krok v poznámke k vydaniu a nechajte udržiavanú dokumentáciu vlastniť celý aktuálny pracovný postup.

Interné prepojenie

Dobré interné prepojenie robí z changelogu historickú vrstvu znalostí o produkte. Prepojte z aktuálnej dokumentácie, keď prechod vysvetľuje zmenené správanie. Prepojte z vydania na presnú dokumentáciu, migráciu, riešenie problémov, politiku alebo usmernenie kompatibility tam, kde to používateľ potrebuje.

Použite jeden kanonický záznam pre každú podstatnú zmenu. Príspevok o spustení, stránka funkcie alebo odpoveď podpory ho môžu citovať; žiadny by ho nemal kopírovať. Archívna navigácia by mala prepájať susedné vydania a index. Pri zastaraní prepojte starý záznam s jeho náhradou a migračné usmernenie späť na oznámenie.

Ako merať výsledky

Merajte, či používatelia nájdu správny záznam, pochopia dopad, dokončia požadovanú akciu a potrebujú menej objasnení. Surové zobrazenia stránok nie sú cieľ: malá oprava môže splniť svoj účel s minimálnou návštevnosťou.

Použite sledovanie promptov pre dopyty obsahujúce produkt a verziu, názvy zmenených funkcií, dátumy zastarania a slovné spojenie „najnovšia aktualizácia". Použite inteligenciu zdrojov a citácií na kontrolu, či AI odpovede citujú kanonický záznam a zachovávajú dostupnosť, dotknutý rozsah, termín a požadovanú akciu. AmICited Cockpit môže umiestniť viditeľnosť súvisiacu s vydaním a citované URL vedľa organickej landing aktivity a vybraných produktových udalostí.

Pred publikovaním zaznamenajte dotknuté publikum, okno zavádzania, objem podpory, migračnú základňu, cieľové dopyty a prompty a udalosť, ktorá dokazuje úspech. Skontrolujte:

• zobrazenia a návštevy pre dopyty týkajúce sa produktu, verzie, funkcie, zastarania a changelogu;
• AI citácie, ktoré reprodukujú správny dátum vydania, stav, hranicu kompatibility a akciu;
• zobrazenia kotiev alebo stránok na úrovni záznamov, nielen zobrazenia indexu changelogu;
• kliknutia na aktualizovanú dokumentáciu, migráciu, riešenie problémov alebo overovacie cesty;
• začatia migrácií, dokončenia overení a zostávajúce staré používanie tam, kde existuje telemetria šetrná k súkromiu;
• kontakty na podporu spôsobené nejasným rozsahom, chýbajúcim prístupom počas zavádzania alebo nedokumentovaným správaním;
• zastarané odpovede po oprave, stiahnutí, nahrádzajúcom vydaní alebo zmene termínu.

Postupujte podľa ako meriame výsledky , aby ste oddelili objavovanie, citácie, angažovanosť, dokončenie úloh, retenciu a obchodné výsledky. Anotujte spustenia, incidenty, kampane a povinné migrácie pred interpretáciou pohybu. Nárast návštevnosti môže indikovať zmätok a citovaná odpoveď je škodlivá, ak vynechá termín zásadnej zmeny.

FAQ

Často kladené otázky