Changelog စာမျက်နှာ တည်ဆောက်နည်း: entry များ၊ tag များ၊ RSS နှင့် 'What's New'
changelog စာမျက်နှာ ဆိုသည်မှာ သင့်ထုတ်ကုန်တွင် ပြောင်းလဲခဲ့သော အရာများကို ရက်စွဲအလိုက် အသစ်ဆုံးက ထိပ်ဆုံးတွင် စာရင်းပြထားသော စာရင်းဖြစ်ပြီး ထိုထုတ်ကုန်ကို သုံးနေသူများအတွက် ရေးထားပါတယ်။ တည်ဆောက်ရန် ရက်စွဲ၊ ရှင်းလင်းသော ခေါင်းစဉ်၊ အတိုချုပ် ရှင်းလင်းချက်နှင့် tag (New၊ Improved၊ Fixed) ပါသော entry များ၊ ၎င်းတို့ကို စာရင်းပြသော စာမျက်နှာ၊ entry တစ်ခုစီအတွက် ကိုယ်ပိုင် URL၊ အကောင်းဆုံးအနေဖြင့် RSS feed နှင့် အသစ်ရှိကြောင်း အသုံးပြုသူကို ပြောပြနည်းတစ်ခု လိုအပ်ပါတယ်။ ရိုးရှင်းဆုံး အရာများထဲမှ တစ်ခုဖြစ်ပြီး အဓိက ဆုံးဖြတ်ချက်မှာ entry များ နေရာ- သင့် site ထဲရှိ ဖိုင်များလား၊ admin စာမျက်နှာပါသော ဒေတာဘေ့စ်လား ဖြစ်ပါတယ်။
changelog ရှိသင့်သည့် အကြောင်းရင်း
changelog သည် ဖောက်သည်များနှင့် စိတ်ဝင်စားသူများကို ထုတ်ကုန်ကို ထိန်းသိမ်းထားကြောင်း ပြသပါတယ်။ "ဒါ X ကို လုပ်နိုင်ပြီလား?" ဟု မေးသောအခါ support နှင့် sales အဖွဲ့များအတွက် ပို့ရန် link တစ်ခု ပေးပါတယ်။ feedback ကို ပိတ်ပေးသည့် နေရာလည်း ဖြစ်ပါတယ်- တောင်းဆိုထားသော feature ထွက်လာသောအခါ changelog entry သည် လူများကို ညွှန်ပြရန် အရာဖြစ်ပါတယ်။ ဖောက်သည် feedback portal ကို လည်ပတ်နေပါက ထုတ်ဝေထားသော တောင်းဆိုမှုများကို ၎င်းတို့၏ entry သို့ တိုက်ရိုက် link ပေးပါ။
changelog သည် သင့် internal commit history မဟုတ်ပါ။ "billing service ကို refactor လုပ်ပြီး" သည် အသုံးပြုသူအတွက် အဓိပ္ပာယ်မရှိပါ။ "Invoice များတွင် ယခု သင့်ကုမ္ပဏီ VAT နံပါတ် ပေါ်ပါမည်" က ရှိပါတယ်။
စာမျက်နှာမှ လိုအပ်ချက်များ
entry တစ်ခုစီအတွက် အကြောင်းအရာ
| Field | မှတ်ချက် |
|---|---|
| ခေါင်းစဉ် | ဘာပြောင်းသွားသလဲ၊ အသုံးပြုသူ၏ အမြင်မှ |
| ရက်စွဲ | ထုတ်ဝေသည့်ရက်စွဲ၊ စာမျက်နှာပေါ်တွင် ပြသ |
| Tag | New၊ Improved၊ Fixed (နှင့် Removed သို့မဟုတ် Security ဖြစ်နိုင်) |
| ခန္ဓာကိုယ် | စာကြောင်းအနည်းငယ် သို့မဟုတ် bullet များ၊ ဘယ်လိုသုံးမလဲ၊ ဘယ်သူရမလဲ |
| ပုံ သို့မဟုတ် ဗီဒီယို | ရွေးချယ်ခွင့်၊ screenshot တစ်ခုက စာပိုဒ်ထက် ပိုအထောက်အကူ ဖြစ်စေပါတယ် |
| Slug | entry ၏ URL၊ ဥပမာ /changelog/invoice-vat-numbers |
| Status | draft သို့မဟုတ် published၊ လိုအပ်ပါက စီစဉ်ထားသော ထုတ်ဝေရက်စွဲ |
စာမျက်နှာများ
- Changelog index: အသစ်ဆုံး ထိပ်ဆုံး၊ tag filter များနှင့်အတူ၊ ရိုးရှင်းသော pagination သို့မဟုတ် "ပိုမို ဖတ်ရန်"။
- Entry စာမျက်နှာ: entry တစ်ခုကို URL တစ်ခုစီဖြင့်၊ link ချိတ်ပြီး မျှဝေနိုင်အောင်။
- RSS သို့မဟုတ် Atom feed: email မလိုဘဲ လူများနှင့် tool များက အပ်ဒိတ်များကို လိုက်ကြည့်နိုင်အောင်။
- Admin စာမျက်နှာ (ဒေတာဘေ့စ် ဗားရှင်းတွင်သာ): entry များ ရေး၊ preview၊ စီစဉ်၊ ထုတ်ဝေ။
အက်ပ်အတွင်း အပို အင်္ဂါရပ်များ
- "What's new" badge: အသုံးပြုသူ မမြင်ရသေးသော entry များရှိသည့်အခါ menu item တွင် အစက်တစ်ခု။ အသုံးပြုသူ နောက်ဆုံး ဖွင့်ခဲ့သော entry ရက်စွဲကို အသုံးပြုသူတစ်ဦးချင်းစီ သို့မဟုတ် browser တွင် သိမ်းပါ။
- Email digest: ရွေးချယ်ထားသော အသုံးပြုသူများထံ ပို့သော အနှစ်ချုပ်။ ပို့ပေးသော provider လိုအပ်ပါတယ်၊ အက်ပ်မှ email ပို့နည်း ကို ကြည့်ပါ။
အဓိက ဆုံးဖြတ်ချက်- ဖိုင် သို့မဟုတ် ဒေတာဘေ့စ်
Site ထဲရှိ ဖိုင်များအဖြစ် entry များ
entry တစ်ခုစီသည် ပရောဂျက်ထဲရှိ Markdown ဖိုင်ဖြစ်ပါတယ်။ entry ထုတ်ဝေခြင်းသည် ဖိုင်ထည့်ပြီး ပြန် deploy လုပ်ခြင်း ဖြစ်ပါတယ်။ ဤနည်းလမ်းသည် ရိုးရှင်းဆုံးနှင့် ခိုင်မာဆုံး ဖြစ်ပါတယ်- ဒေတာဘေ့စ် မလို၊ admin login မလို၊ လုံခြုံရေး ထိန်းသိမ်းစရာ မရှိ၊ စာမျက်နှာများကို pre-render လုပ်နိုင်ပြီး မြန်ဆန်စွာ load ဖြစ်ကာ search engine များက ဖတ်ရလွယ်ပါတယ်။
entry ရေးသူများက AI builder ကို မေးခြင်း သို့မဟုတ် ဖိုင်တည်းဖြတ်ခြင်းတွင် သက်တောင့်သက်သာ ရှိသော အဖွဲ့များအတွက် သင့်တော်ပါတယ်။
Admin စာမျက်နှာပါသော ဒေတာဘေ့စ်တွင် entry များ
entry များသည် ဇယားတစ်ခုတွင် နေပြီး သီးခြား admin စာမျက်နှာက အဖွဲ့ထဲရှိ မည်သူမဆို ရေး၊ preview၊ စီစဉ်၊ ထုတ်ဝေနိုင်ပါတယ်။ ဈေးကွက်ရေး သို့မဟုတ် support က အပ်ဒိတ်ရေးသည့် အဖွဲ့များ၊ သို့မဟုတ် အချိန်ဇယားဖြင့် ထုတ်ဝေခြင်း သို့မဟုတ် ပရိသတ်အလိုက် entry (ဥပမာ enterprise feature များကို enterprise ဖောက်သည်များကိုသာ ပြ) လိုချင်သော အဖွဲ့များအတွက် သင့်တော်ပါတယ်။
ကုန်ကျစရိတ်မှာ တည်ဆောက်ရ ပိုများပြီး ထိန်းသိမ်းရ ပိုရှုပ်ထွေးပါတယ်- admin login၊ ပုံ upload၊ နှင့် ပြည်သူ့စာမျက်နှာများကို search engine များက ဖတ်နိုင်ဆဲ ဖြစ်အောင် ထိန်းသိမ်းခြင်း (ဒေတာကို browser တွင်သာ load လုပ်သော စာမျက်နှာက မမြင်နိုင်နိုင်ပါ)။
| ဖိုင်များ | ဒေတာဘေ့စ် + admin | |
|---|---|---|
| ဘယ်သူ ထုတ်ဝေနိုင်လဲ | ပရောဂျက်ကို တည်းဖြတ်သူ မည်သူမဆို | admin login ရှိသူ မည်သူမဆို |
| တပ်ဆင်မှု | အနည်းဆုံး | login၊ သိုလှောင်မှု၊ admin UI |
| SEO | လွယ် (pre-rendered စာမျက်နှာများ) | server ပေါ်တွင် သို့မဟုတ် pre-render ဖြင့် ဖော်ပြဖို့ ဂရုစိုက်ရ |
| စီစဉ်ခြင်း | ထုတ်ဝေမှုကို deploy တွင် | ရက်စွဲဖြင့် စီစဉ်နိုင် |
| Hosting ကုန်ကျစရိတ် | Static | အလုပ်လုပ်နေသော အက်ပ်နှင့် ဒေတာဘေ့စ် လိုအပ် |
လူများ ဖတ်ချင်သော entry များ ရေးခြင်း
- အကျိုးကျေးဇူးဖြင့် ဦးဆောင်ပါ။ "Excel သို့ report export လုပ်နိုင်ပြီ" သည် "Export module အသစ်" ထက် ပိုကောင်းသည်။
- ဘယ်သူရမလဲ ပြောပါ။ plan အားလုံး၊ Pro သာ၊ ဒီအပတ် ထုတ်လွှတ်နေသည်။
- ပြပါ။ screenshot သို့မဟုတ် တိုတောင်းသော clip တစ်ခု။
- အသေးစား ပြင်ဆင်မှုများကို အုပ်စုဖွဲ့ပါ။ "ပြင်ဆင်မှုနှင့် တိုးတက်မှု" အပတ်စဉ် entry နှင့် bullet များက စာမျက်နှာကို ပြည့်လျှံခြင်းမှ ကာကွယ်ပါတယ်။
- ဖယ်ရှားမှုများကို ရိုးသားစွာ ပြောပါ။ တစ်ခုခု ပျောက်သွားမည်ဆိုလျှင် ဘယ်အချိန်နှင့် အစားထိုးရမည်ကို ပြောပါ။
အလုပ်ဖြစ်သော ပထမ prompt
ကျွန်ုပ်တို့၏ site တွင် /changelog တွင် public changelog ထည့်ပါ။ entry တစ်ခုစီသည် ခေါင်းစဉ်၊ ရက်စွဲ၊ tag (New၊ Improved သို့မဟုတ် Fixed)၊ ရွေးချယ်ခွင့် cover ပုံနှင့် ခန္ဓာကိုယ်ပါသော Markdown ဖိုင်ဖြစ်သည်။ index စာမျက်နှာသည် entry များကို အသစ်ဆုံးက ထိပ်ဆုံးတွင် ရက်စွဲ၊ tag နှင့် ပထမစာပိုဒ်ဖြင့် ပြ၊ tag filter ခလုတ်များရှိ၊ စာမျက်နှာတစ်ခုလျှင် entry ၁၀ ခု ပြပါ။ entry တစ်ခုစီသည် /changelog/<slug> တွင် ကိုယ်ပိုင် စာမျက်နှာရှိပြီး search engine များအတွက် သင့်တော်သော page title နှင့် description ပါစေ။ /changelog/rss.xml တွင် RSS feed ထည့်ပါ။ နမူနာ entry သုံးခု ဖန်တီးပါ။ လက်ရှိ site ဒီဇိုင်းနှင့် ကိုက်ညီစေပြီး ဖုန်းပေါ်တွင် ဖတ်ရလွယ်စေကာ စာမျက်နှာများကို pre-render လုပ်ပါ ဒါမှ မြန်မြန် load ဖြစ်မည်။
ဒေတာဘေ့စ် ဗားရှင်းအတွက် ပထမ ဝါကျကို "entry များကို draft/published status နှင့် ထုတ်ဝေရက်စွဲပါသော ဒေတာဘေ့စ်တွင် သိမ်းပြီး ရေး၊ preview နှင့် ထုတ်ဝေနိုင်သော password ဖြင့် ကာကွယ်ထားသော admin စာမျက်နှာ ထည့်ပါ" ဟု အစားထိုးပါ။
တည်ဆောက်ရန် အဆင့်များ
- အပေါ်ပါ ဇယားကို အသုံးပြု၍ ဖိုင် သို့မဟုတ် ဒေတာဘေ့စ်ကို ဆုံးဖြတ်ပါ။
- index နှင့် entry စာမျက်နှာများကို နမူနာ entry အနည်းငယ်ဖြင့် တည်ဆောက်ပါ။
- tag များနှင့် filter များ ထည့်ပါ။
- RSS feed ထည့်ပြီး စာမျက်နှာမှ link ချိတ်ပါ။
- entry တစ်ခုစီအတွက် page title၊ description နှင့် sitemap entry ထည့်ပါ။ AI-built ဝက်ဘ်ဆိုက်များအတွက် SEO က အခြေခံများကို ဖုံးပါတယ်။
- Admin စာမျက်နှာနှင့် login၊ ဒေတာဘေ့စ် လမ်းကြောင်းကို ရွေးခဲ့ပါက။
- အက်ပ်ထဲရှိ "What's new" badge။
- လွန်ခဲ့သော လအနည်းငယ်အတွက် အမှန်တကယ် entry များ ရေးပါ ဒါမှ စာမျက်နှာ ဗလာဖြင့် မစတင်ရန်။
အဖြစ်များသော အမှားများ
- commit message များကို ကူးခြင်း။ ဖတ်သူအတွက် ရေးပါ၊ developer အတွက် မဟုတ်ပါ။
- entry URL မပါသော စာမျက်နှာကြီးတစ်ခု။ လူများက ပြောင်းလဲမှုတစ်ခုကို link ချိတ်၍ မရနိုင်ပြီး search engine က စာမျက်နှာ အများအပြား အစား တစ်ခုတည်း မြင်ပါတယ်။
- တစ်လကြာလျှင် အပ်ဒိတ် ရပ်သွားခြင်း။ နှစ်တစ်နှစ်ကြာ အပ်ဒိတ်မလုပ်ထားသော changelog သည် စွန့်ပစ်ထားသော ထုတ်ကုန်ကို ညွှန်ပါတယ်။ ထိန်းနိုင်သော ရိုက်ချက်ကို သတ်မှတ်ပါ။
- ဒေတာဘေ့စ်ကို browser တွင်သာ load လုပ်ခြင်း။ search engine များနှင့် link preview များက ဗလာစာမျက်နှာကို မြင်နိုင်ပါတယ်။ pre-render သို့မဟုတ် server ပေါ်တွင် render လုပ်ပါ။
- ဖြစ်ရပ်များကို ရောထည့်ခြင်း။ အပြင်ပိတ်ချိန် (outage) များသည် status page တွင် ရှိသင့်ပြီး changelog တွင် မဟုတ်ပါ။
Hosted changelog tool က ပိုကောင်းသည့်အခါ
hosted changelog နှင့် product-update tool များ ရှိပြီး အချို့မှာ feedback board သို့မဟုတ် in-app widget များနှင့် ပါလာပါတယ်။ in-app popup၊ ပရိသတ်ပစ်မှတ်ချခြင်းနှင့် analytics ကို မတည်ဆောက်ချင်လျှင်၊ သို့မဟုတ် သင့်အဖွဲ့က ပါဝင်သော tool ကို ပေးဆောင်ပြီးသားဖြစ်လျှင် ၎င်းတို့က တန်ဖိုးရှိပါတယ်။ သင့် blog သို့မဟုတ် help center software တွင် သင့်တော်သော ပုံစံ ရှိပြီးသားလည်း ဖြစ်နိုင်ပါတယ်။
changelog ကို သင့်ကိုယ်ပိုင် domain၊ ကိုယ်ပိုင် ဒီဇိုင်းဖြင့် အပြည့်အဝ index လုပ်နိုင်အောင် လိုချင်သောအခါ ကိုယ်ပိုင် တည်ဆောက်ပါ။ ရက်စွဲပါ ပို့စ်များ၏ ရိုးရှင်းသော စာရင်းအတွက် အလုပ်မများပါ။
Mythex ဖြင့် တည်ဆောက်ခြင်း
Mythex တွင် ရှိပြီးသား ပရောဂျက်သို့ changelog ထည့်ရန် agent ကို မေးနိုင်သလို၊ သီးခြား သေးငယ်သော site အဖြစ် တည်ဆောက်ပြီး တည်ဆောက်နေစဉ် live preview တွင် ကြည့်နိုင်ပါတယ်။ ဖိုင်အခြေခံ ဗားရှင်းသည် ဒေတာဘေ့စ် မလိုပါ။ admin ဗားရှင်းကို ရွေးပါက entry များသိမ်းရန် လိုအပ်သောအခါ agent က သီးသန့် Postgres ဒေတာဘေ့စ် ထည့်ပေးပါမည် (သို့မဟုတ် /database ဟု ရိုက်ပါ)၊ screenshot များက ပရောဂျက် file storage ထဲ သွားပါမည်။ admin ဝင်ရောက်ခြင်းကို သင့်ကိုယ်ပိုင် auth နည်းလမ်းဖြင့် ထည့်ပါ (login ထည့်ခြင်း recipe)။
Mythex ၏ ခေတ်မီ အက်ပ်များသည် မကြာခဏ client-rendered single-page app များ ဖြစ်ပြီး SEO recipe က ၎င်းတို့သည် ရှာဖွေရေးအတွက် အားနည်းကြောင်း သတိပေးပါတယ်၊ ထို့ကြောင့် entry များကို ရှာတွေ့စေချင်ပါက static သို့မဟုတ် pre-rendered changelog စာမျက်နှာများကို တောင်းပါ။ recipe တွင် title၊ description နှင့် sitemap များကိုလည်း ဖုံးပါတယ်။ built-in changelog ပါသော စတင်ရန် နေရာအတွက် product knowledge hub template ကို ကြည့်ပါ။
မေးခွန်းများ
changelog entry တစ်ခုတွင် ဘာတွေ ပါသင့်သလဲ။
ရက်စွဲ၊ အသုံးပြုသူ၏ အမြင်မှ ဘာပြောင်းသွားသလဲ ပြောသော ခေါင်းစဉ်တိုတစ်ခု၊ အကြောင်းရင်းကို ရှင်းပြသော စာကြောင်းအနည်းငယ် သို့မဟုတ် bullet များ၊ New၊ Improved သို့မဟုတ် Fixed ကဲ့သို့ tag တစ်ခု၊ နှင့် ရွေးချယ်ခွင့်အဖြစ် screenshot နှင့် အသေးစိတ်အတွက် link။
changelog အတွက် ဒေတာဘေ့စ် လိုအပ်လား။
မလိုအပ်ပါဘူး။ လူတစ်ဦး သို့မဟုတ် နှစ်ဦးသာ အပ်ဒိတ်ထုတ်ပါက entry များကို site ထဲရှိ Markdown ဖိုင်များအဖြစ် ထားပြီး deploy တိုင်းတွင် ထုတ်ဝေနိုင်ပါတယ်။ နည်းပညာမဆိုင်သူများက admin စာမျက်နှာမှ entry များကို ရေး၊ စီစဉ်ထုတ်ဝေရန် လိုအပ်သောအခါ ဒေတာဘေ့စ် သုံးပါ။
changelog ကို ဘယ်လောက်ကြာကြာ အပ်ဒိတ်လုပ်သင့်သလဲ။
အသုံးပြုသူများ သတိပြုမိမည့် ပြောင်းလဲမှု တစ်ခုခု ရှိသည့်အခါတိုင်း ဖြစ်ပါတယ်။ သေးငယ်သော ထုတ်ကုန်အများအပြားက ပြောင်းလဲမှုများကို အပတ်စဉ် သို့မဟုတ် နှစ်ပတ်တစ်ကြိမ် စုစည်းကြပါတယ်၊ အရေးကြီးသည်မှာ စာမျက်နှာ အသက်ဝင်နေအောင် တသမတ်တည်း ရိုက်ချက်ရှိရန် ဖြစ်ပါတယ်။
changelog သည် SEO အတွက် ကောင်းသလား။
အနည်းငယ် ကူညီနိုင်ပါတယ်- entry တစ်ခုစီသည် feature တစ်ခုအကြောင်း search engine က crawl လုပ်နိုင်သော စာမျက်နှာဖြစ်ပြီး ပုံမှန် အပ်ဒိတ်ခံရသော စာမျက်နှာက ထုတ်ကုန် တက်ကြွနေကြောင်း ပြသပါတယ်။ entry တစ်ခုစီကို ကိုယ်ပိုင် URL နှင့် ဖော်ပြသော ခေါင်းစဉ်ပေးပါ။