Jinsi ya Kujenga Ukurasa wa Changelog: Maingizo, Tagi, RSS na 'Kipya'

Ukurasa wa changelog ni orodha ya mabadiliko ya bidhaa yako kwa mpangilio wa tarehe, mapya kwanza, iliyoandikwa kwa ajili ya watu wanaoitumia. Kujenga moja unahitaji maingizo yenye tarehe, kichwa wazi, maelezo mafupi na tagi (Mpya, Imeboreshwa, Imerekebishwa), ukurasa unaoyaorodhesha, URL tofauti kwa kila ingizo, na ikiwezekana RSS feed pamoja na njia ya kuwaambia watumiaji kwamba kuna kitu kipya. Ni mojawapo ya vitu rahisi zaidi unavyoweza kujenga, na uamuzi mkuu ni mahali maingizo yanapoishi: kama faili ndani ya tovuti yako, au kwenye database yenye ukurasa wa admin.

Kwa nini changelog inafaa

Changelog inaonyesha wateja na wateja watarajiwa kwamba bidhaa inatunzwa. Inawapa timu ya msaada na mauzo kiungo cha kutuma mtu anapouliza "je, bado inafanya X?". Pia ni mahali pa kufunga mzunguko wa maoni: kipengele kilichoombwa kinapotoka, ingizo la changelog ndilo unalowaelekeza watu. Ukiendesha portal ya maoni ya wateja, unganisha maombi yaliyotekelezwa moja kwa moja na maingizo yao.

Changelog si historia ya commit zako za ndani. "Imerekebisha huduma ya billing" haimaanishi chochote kwa mtumiaji. "Ankara sasa zinaonyesha namba ya VAT ya kampuni yako" inamaanisha.

Ukurasa unahitaji nini

Maudhui ya kila ingizo

Kurasa

• Ukurasa mkuu wa changelog: mapya kwanza, pamoja na vichujio vya tagi na kurasa rahisi au kitufe cha "pakia zaidi".
• Ukurasa wa ingizo: ingizo moja kwa URL, ili liweze kuunganishwa na kushirikiwa.
• RSS au Atom feed: inawaruhusu watu na zana kufuatilia masasisho bila barua pepe.
• Ukurasa wa admin (kwenye toleo la database pekee): andika, hakiki, panga na chapisha maingizo.

Vya ziada ndani ya app

• Beji ya "Kipya": nukta kwenye kipengele cha menyu wakati kuna maingizo ambayo mtumiaji hajayaona. Hifadhi tarehe ya ingizo la mwisho alilolifungua, kwa kila mtumiaji au kwenye browser.
• Muhtasari wa barua pepe: muhtasari unaotumwa kwa watumiaji walioamua kupokea. Hii inahitaji mtoa huduma wa kutuma barua pepe; angalia jinsi ya kutuma barua pepe kutoka kwenye app yako.

Uamuzi mkuu: faili au database

Maingizo kama faili ndani ya tovuti

Kila ingizo ni faili ya Markdown ndani ya mradi. Kuchapisha ingizo ni kuongeza faili na ku-redeploy. Hii ndiyo njia rahisi na imara zaidi: hakuna database, hakuna kuingia kwa admin, hakuna cha kulinda, na kurasa zinaweza kuwa pre-rendered ili zipakie haraka na injini za utafutaji ziweze kuzisoma kwa urahisi.

Inafaa timu ambapo watu wanaoandika maingizo wanastarehe kuomba AI builder au kuhariri faili.

Maingizo kwenye database yenye ukurasa wa admin

Maingizo yanaishi kwenye jedwali, na ukurasa wa admin wa faragha unamruhusu yeyote kwenye timu kuandika, kuhakiki, kupanga na kuchapisha. Hii inafaa timu ambapo masoko au msaada ndio wanaoandika masasisho, au unapotaka kuchapisha kwa ratiba au maingizo kwa hadhira maalum (kwa mfano, vipengele vya biashara vinaonekana kwa wateja wa biashara pekee).

Gharama yake ni kazi zaidi ya kujenga na kutunza: kuingia kwa admin, upakiaji wa picha, na kuhakikisha kurasa za umma bado zinaweza kusomwa na injini za utafutaji, jambo ambalo ukurasa unaopakia maingizo kwenye kivinjari pekee huenda usiweze kulifanya.

Kuandika maingizo ambayo watu wanayasoma

• Anza na faida. "Hamisha ripoti kwenda Excel" ni bora kuliko "Moduli mpya ya export".
• Sema nani anayeipata. Mipango yote, Pro pekee, inazinduliwa wiki hii.
• Ionyeshe. Picha moja ya skrini au klipu fupi.
• Kusanya marekebisho madogo. Ingizo la kila wiki la "Marekebisho na maboresho" lenye pointi linazuia ukurasa usijazwe.
• Kuwa mwaminifu kuhusu kuondoa. Kama kitu kinaondoka, sema lini na nini cha kutumia badala yake.

Ombi la kwanza linalofanya kazi

Ongeza changelog ya umma kwenye tovuti yetu kwenye /changelog. Kila ingizo ni faili ya Markdown yenye kichwa, tarehe, tagi (Mpya, Imeboreshwa au Imerekebishwa), picha ya jalada ya hiari na maudhui. Ukurasa mkuu unaorodhesha maingizo mapya kwanza ukionyesha tarehe, tagi na aya ya kwanza, una vitufe vya vichujio vya tagi, na unaonyesha maingizo 10 kwa ukurasa. Kila ingizo lina ukurasa wake kwenye /changelog/<slug> wenye kichwa na maelezo sahihi kwa injini za utafutaji. Ongeza RSS feed kwenye /changelog/rss.xml. Tengeneza maingizo matatu ya mfano. Oanisha muundo wa tovuti iliyopo, weka usomeke kwenye simu, na pre-render kurasa ili zipakie haraka.

Kwa toleo la database, badilisha sentensi ya kwanza iwe "Hifadhi maingizo kwenye database yenye hali ya rasimu/imechapishwa na tarehe ya kuchapisha, na ongeza ukurasa wa admin uliolindwa kwa nywila wa kuandika, kuhakiki na kuchapisha."

Hatua za ujenzi

1. Amua faili au database kwa kutumia jedwali lililo hapo juu.
2. Jenga ukurasa mkuu na wa ingizo kwa maingizo machache ya mfano.
3. Ongeza tagi na vichujio.
4. Ongeza RSS feed na uiunganishe kutoka kwenye ukurasa.
5. Ongeza vichwa vya kurasa, maelezo na ingizo la sitemap kwa kila ingizo. Mwongozo wetu wa SEO kwa tovuti zilizojengwa kwa AI unashughulikia misingi.
6. Ukurasa wa admin na kuingia, ikiwa umechagua njia ya database.
7. Beji ya "Kipya" ndani ya app yako.
8. Andika maingizo halisi ya miezi michache iliyopita ili ukurasa usizinduliwe ukiwa tupu.

Makosa ya kawaida

• Kunakili ujumbe wa commit. Andika kwa watumiaji, si kwa wasanidi.
• Ukurasa mmoja mkubwa usio na URL za kila ingizo. Hakuna anayeweza kuunganisha mabadiliko mahususi, na injini za utafutaji zinaona ukurasa mmoja badala ya nyingi.
• Masasisho yanakoma baada ya mwezi mmoja. Changelog iliyosasishwa mara ya mwisho mwaka mmoja uliopita inapendekeza bidhaa iliyoachwa. Weka mdundo unaoweza kuudumisha.
• Kupakia maingizo kwenye kivinjari pekee. Injini za utafutaji na hakiki za viungo zinaweza kuona ukurasa tupu. Pre-render au rendera kwenye server.
• Kuchanganya matukio. Hitilafu za huduma zinapaswa kuwa kwenye ukurasa wa hali, si kwenye changelog.

Wakati zana ya changelog inayohostiwa ni chaguo bora

Zana za changelog na masasisho ya bidhaa zinazohostiwa zipo, na baadhi zinakuja zikiwa na mbao za maoni au widgets za ndani ya app. Zinafaa ukitaka popup ndani ya app, ulengaji wa hadhira na uchanganuzi bila kuvijenga wewe mwenyewe, au ikiwa timu yako tayari inalipia zana inayojumuisha hayo. Software yako ya blogu au kituo cha msaada pia inaweza kuwa na muundo unaofaa tayari.

Jenga yako mwenyewe unapotaka changelog kwenye domain yako, kwa muundo wako, na inayoweza kuorodheshwa kikamilifu, ambayo kwa orodha rahisi ya machapisho yenye tarehe si kazi kubwa.

Kuijenga na Mythex

Kwenye Mythex unaweza kumwomba wakala aongeze changelog kwenye mradi uliopo au kuijenga kama tovuti ndogo yenyewe, na kuiona kwenye hakiki ya moja kwa moja inavyojengwa. Toleo la faili halihitaji database. Ukichagua toleo la admin, wakala anaongeza database maalum ya Postgres maingizo yanapohitaji kuhifadhiwa (au andika /database), na picha za skrini zinakwenda kwenye hifadhi ya faili ya mradi. Kuingia kwa admin ni kitu unachoongeza kwa njia yako mwenyewe ya uthibitishaji (mapishi ya kuongeza kuingia).

Apps mpya za Mythex mara nyingi ni single-page apps zinazorenderiwa kwenye kivinjari, ambazo mapishi ya SEO yanabainisha kuwa ni dhaifu kwa utafutaji, kwa hiyo omba kurasa za changelog zilizo static au pre-rendered ikiwa unataka maingizo yapatikane kwenye utafutaji. Mapishi hayo hayo yanashughulikia vichwa, maelezo na sitemaps. Kwa mwanzo wenye changelog iliyojengwa ndani, angalia kiolezo cha product knowledge hub.

Maswali