Paano Gumawa ng Changelog Page: Entries, Tags, RSS at "What's New"

Ang changelog page ay listahan ng mga pagbabago sa product mo, ayon sa petsa at pinakabago muna, na isinulat para sa mga taong gumagamit nito. Para itayo ito, kailangan mo ng mga entry na may petsa, malinaw na title, maikling paliwanag at tag (New, Improved, Fixed), page na naglilista sa mga ito, hiwalay na URL bawat entry, at mainam na RSS feed at paraan para sabihin sa user na may bago. Isa ito sa pinakasimpleng bagay na puwede mong itayo, at ang pangunahing desisyon ay kung saan nakatira ang mga entry: bilang file sa site mo, o sa database na may admin page.

Bakit sulit magkaroon ng changelog

Ipinapakita ng changelog sa mga customer at prospect na inaalagaan ang product. Binibigyan nito ang support at sales ng link na maipapadala kapag may nagtanong na "kaya na ba nitong gawin ang X?". Lugar din ito para isara ang loop ng feedback: kapag nailabas na ang hiniling na feature, ang entry sa changelog ang itinuturo mo sa mga tao. Kung nagpapatakbo ka ng customer feedback portal, i-link nang direkta ang mga naihatid na request sa kanilang entry.

Hindi ang internal commit history mo ang changelog. Walang kahulugan sa user ang "Refactored billing service". Ang "Ipinapakita na ngayon ng mga invoice ang VAT number ng kumpanya mo" ay may kahulugan.

Ano ang kailangan ng page

Nilalaman ng bawat entry

Mga page

• Index ng changelog: pinakabago muna, may tag filter at simpleng pagnunumero ng pahina o "load more".
• Entry page: isang entry bawat URL, para ma-link at maibahagi.
• RSS o Atom feed: nagpapahintulot sa mga tao at tool na sumunod sa update nang walang email.
• Admin page (sa bersyong database lang): sumulat, mag-preview, mag-iskedyul at mag-publish ng entries.

Mga dagdag sa loob ng app

• Badge na "What's new": tuldok sa menu item kapag may mga entry na hindi pa nakikita ng user. Itago ang petsa ng huling entry na binuksan nila, kada user o sa browser.
• Email digest: buod na ipinapadala sa mga user na nag-opt in. Kailangan nito ng sending provider; tingnan ang paano magpadala ng email mula sa app.

Ang pangunahing desisyon: files o database

Entries bilang files sa site

Bawat entry ay Markdown file sa project. Ang pag-publish ng entry ay pagdagdag ng file at pag-redeploy. Ito ang pinakasimple at pinakamatatag na paraan: walang database, walang admin login, walang kailangang i-secure, at puwedeng i-pre-render ang mga page para mabilis mag-load at madaling basahin ng search engine.

Bagay ito sa mga team kung saan komportable ang mga sumusulat ng entry na humingi sa AI builder o mag-edit ng file.

Entries sa database na may admin page

Nakatira ang mga entry sa table, at pinapayagan ng pribadong admin page ang sinumang nasa team na sumulat, mag-preview, mag-iskedyul at mag-publish. Bagay ito sa mga team kung saan nagsusulat ng update ang marketing o support, o kapag gusto mo ng naka-iskedyul na publish o entry bawat audience (halimbawa, ipakita lang ang enterprise feature sa enterprise customer).

Ang kapalit ay mas maraming gawain at pag-aalaga: admin login, pag-upload ng larawan, at siguraduhing nababasa pa rin ng search engine ang mga pampublikong page, na maaaring hindi mangyari sa page na naglo-load lang ng entries sa browser.

Pagsulat ng entries na binabasa ng tao

• Simulan sa benepisyo. Mas maganda ang "Mai-export ang mga report sa Excel" kaysa "Bagong export module".
• Sabihin kung sino ang makakakuha. Lahat ng plan, Pro lang, unti-unting ilalabas ngayong linggo.
• Ipakita. Isang screenshot o maikling clip.
• Pagpangkatin ang maliliit na ayos. Ang lingguhang entry na "Mga ayos at pagpapabuti" na may bullet ay pumipigil sa page na mapuno.
• Maging tapat sa mga tinatanggal. Kung may mawawala, sabihin kung kailan at ano ang gamitin sa halip.

Unang prompt na gumagana

Magdagdag ng pampublikong changelog sa site namin sa /changelog. Bawat entry ay Markdown file na may title, petsa, tag (New, Improved o Fixed), opsyonal na cover image at body. Ang index page ay naglilista ng entries, pinakabago muna, na may petsa, tag at unang talata, may tag filter button, at nagpapakita ng 10 entry bawat pahina. Bawat entry ay may sariling page sa /changelog/<slug> na may tamang page title at description para sa search engine. Magdagdag ng RSS feed sa /changelog/rss.xml. Gumawa ng tatlong sample na entry. Itugma sa umiiral na disenyo ng site, maging madaling basahin sa telepono, at i-pre-render ang mga page para mabilis mag-load.

Para sa bersyong database, palitan ang unang pangungusap ng "Mag-store ng entries sa database na may draft/published status at publish date, at magdagdag ng password-protected na admin page para sumulat, mag-preview at mag-publish ng mga ito."

Mga hakbang sa pagbuo

1. Magpasya ng files o database gamit ang talahanayan sa itaas.
2. Itayo ang index at entry page kasama ang ilang sample na entry.
3. Magdagdag ng tag at filter.
4. Idagdag ang RSS feed at i-link ito mula sa page.
5. Magdagdag ng page title, description at entry sa sitemap para sa bawat entry. Sakop ng gabay namin sa SEO para sa AI-built na website ang mga batayan.
6. Admin page at login, kung piniling bersyong database.
7. Badge na "What's new" sa app mo.
8. Sumulat ng totoong entry para sa nakaraang ilang buwan para hindi walang laman ang page sa paglulunsad.

Mga karaniwang pagkakamali

• Pagkopya ng commit message. Sumulat para sa user, hindi para sa developer.
• Iisang mahabang page na walang URL bawat entry. Walang makakapag-link sa partikular na pagbabago, at nakikita ng search engine ang isang page sa halip na marami.
• Humihinto ang update pagkatapos ng isang buwan. Ang changelog na huling na-update isang taon na ang nakalipas ay nagpapahiwatig ng inabandunang product. Magtakda ng ritmo na kaya mong panatilihin.
• Pag-load ng entries sa browser lang. Maaaring walang laman ang nakikita ng search engine at link preview. I-pre-render o i-render sa server.
• Paghahalo ng insidente. Ang outage ay nasa status page, hindi sa changelog.

Kailan mas bagay ang handa nang changelog tool

May mga hosted na changelog at product-update tool, at ang ilan ay kasama ng feedback board o in-app widget. Sulit ang mga ito kung gusto mo ng in-app popup, audience targeting at analytics nang hindi itinatayo, o kung may bayad na tool na ang team mo na may kasamang ganito. Maaari ring may angkop nang format ang iyong blog o help center software.

Gumawa ng sarili kapag gusto mong nasa sarili mong domain, sa sarili mong disenyo, at ganap na ma-index ang changelog, na para sa simpleng listahan ng dated na post ay hindi naman gaanong trabaho.

Pagbuo nito gamit ang Mythex

Sa Mythex, puwede mong hilingin sa agent na magdagdag ng changelog sa umiiral na project o itayo ito bilang sariling maliit na site, at makikita mo ito sa live preview habang itinatayo. Hindi kailangan ng database ng bersyong file-based. Kung pipiliin mo ang bersyong admin, nagdadagdag ang agent ng nakalaang Postgres database kapag kailangang i-save ang entries (o i-type ang /database), at ang mga screenshot ay nasa project file storage. Ang admin sign-in ay idinadagdag mo gamit ang sarili mong auth approach (add login recipe).

Kadalasang client-rendered single-page app ang mga bagong Mythex app, na sinasabi ng SEO recipe na mahina sa search, kaya humingi ng static o pre-rendered na changelog page kung gusto mong makita ang mga entry sa search. Sakop din ng parehong recipe ang mga title, description at sitemap. Para sa panimulang punto na may built-in na changelog, tingnan ang product knowledge hub na template.

Mga tanong