चेंजलॉग पेज कैसे बनाएँ: एंट्री, टैग, RSS और 'नया क्या है'
चेंजलॉग पेज आपके प्रोडक्ट में क्या बदला, उसकी तारीख के साथ सूची है, सबसे नई पहले, उन लोगों के लिए लिखी गई जो उसका उपयोग करते हैं। इसे बनाने के लिए आपको ऐसी एंट्री चाहिए जिनमें तारीख, स्पष्ट शीर्षक, छोटी व्याख्या और एक टैग (New, Improved, Fixed) हो, एक पेज जो उन्हें सूचीबद्ध करे, हर एंट्री का अलग URL, और आदर्श रूप से एक RSS फ़ीड और यूज़रों को बताने का तरीका कि कुछ नया है। यह सबसे सरल चीज़ों में से एक है, और मुख्य फ़ैसला यह है कि एंट्री कहाँ रहेंगी: आपकी साइट में फ़ाइलों के रूप में, या एडमिन पेज वाले डेटाबेस में।
चेंजलॉग क्यों उपयोगी है
चेंजलॉग ग्राहकों और संभावित ग्राहकों को दिखाता है कि प्रोडक्ट का रख-रखाव हो रहा है। सपोर्ट और सेल्स के पास एक लिंक होता है जो तब भेजा जा सकता है जब कोई पूछे “क्या इसमें X अभी है?”। यह फ़ीडबैक का चक्र बंद करने की जगह भी है: जब माँगा गया फ़ीचर आता है, तो चेंजलॉग एंट्री वही है जिसकी ओर आप लोगों को भेजते हैं। अगर आप ग्राहक फ़ीडबैक पोर्टल चलाते हैं, तो पूरी हुई माँगों को सीधे उनकी एंट्री से जोड़ें।
चेंजलॉग आपका आंतरिक कमिट इतिहास नहीं है। “Refactored billing service” यूज़र के लिए कुछ नहीं कहता। “Invoices अब आपकी कंपनी का VAT नंबर दिखाते हैं” कहता है।
पेज में क्या होना चाहिए
हर एंट्री की सामग्री
| फ़ील्ड | नोट्स |
|---|---|
| शीर्षक | क्या बदला, यूज़र के दृष्टिकोण से |
| तारीख | प्रकाशन की तारीख, पेज पर दिखाई जाए |
| टैग | New, Improved, Fixed (और शायद Removed या Security) |
| मुख्य भाग | कुछ वाक्य या बुलेट; उसका उपयोग कैसे करें, किसे मिलता है |
| इमेज या वीडियो | वैकल्पिक; एक स्क्रीनशॉट एक पैराग्राफ़ से ज़्यादा मदद करता है |
| Slug | एंट्री का URL, जैसे /changelog/invoice-vat-numbers |
| स्टेटस | ड्राफ़्ट या प्रकाशित, ज़रूरत हो तो शेड्यूल्ड प्रकाशन तारीख के साथ |
पेज
- चेंजलॉग इंडेक्स: सबसे नई पहले, टैग फ़िल्टर और सरल पेजिनेशन या “और दिखाएँ” के साथ।
- एंट्री पेज: हर URL पर एक एंट्री, ताकि उसे लिंक और साझा किया जा सके।
- RSS या Atom फ़ीड: लोग और टूल ईमेल के बिना अपडेट फ़ॉलो कर सकें।
- एडमिन पेज (केवल डेटाबेस वाले संस्करण में): एंट्री लिखें, प्रीव्यू करें, शेड्यूल करें और प्रकाशित करें।
ऐप के भीतर के अतिरिक्त
- “नया क्या है” बैज: किसी मेन्यू आइटम पर एक बिंदु जब यूज़र ने अभी तक न देखी गई एंट्री हों। आखिरी एंट्री की तारीख जो यूज़र ने खोली थी, प्रति यूज़र या ब्राउज़र में सहेजें।
- ईमेल डाइजेस्ट: उन यूज़रों को भेजा गया सारांश जिन्होंने सहमति दी है। इसके लिए एक भेजने वाला प्रोवाइडर चाहिए; देखें अपने ऐप से ईमेल कैसे भेजें।
मुख्य फ़ैसला: फ़ाइलें या डेटाबेस
साइट में फ़ाइलों के रूप में एंट्री
हर एंट्री प्रोजेक्ट में एक Markdown फ़ाइल है। एंट्री प्रकाशित करने का मतलब है एक फ़ाइल जोड़ना और फिर से डिप्लॉय करना। यह सबसे सरल और सबसे मज़बूत तरीका है: कोई डेटाबेस नहीं, कोई एडमिन लॉगिन नहीं, सुरक्षित करने को कुछ नहीं, और पेज पहले से रेंडर हो सकते हैं, जिससे वे तेज़ लोड होते हैं और सर्च इंजन के लिए पढ़ने में आसान होते हैं।
यह उन टीमों के लिए ठीक है जहाँ एंट्री लिखने वाले लोग AI बिल्डर से पूछने या फ़ाइल संपादित करने में सहज हैं।
एडमिन पेज वाले डेटाबेस में एंट्री
एंट्री एक टेबल में रहती हैं, और एक निजी एडमिन पेज हर टीम सदस्य को लिखने, प्रीव्यू करने, शेड्यूल करने और प्रकाशित करने देता है। यह उन टीमों के लिए ठीक है जहाँ मार्केटिंग या सपोर्ट अपडेट लिखते हैं, या जहाँ आपको शेड्यूल्ड प्रकाशन या हर दर्शक वर्ग के लिए अलग एंट्री चाहिए (जैसे, एंटरप्राइज़ फ़ीचर केवल एंटरप्राइज़ ग्राहकों को दिखाना)।
इसकी कीमत है बनाने और चलाने में ज़्यादा मेहनत: एडमिन लॉगिन, इमेज अपलोड, और यह सुनिश्चित करना कि सार्वजनिक पेज अब भी सर्च इंजन द्वारा पढ़े जा सकें, जो शायद उस पेज के लिए संभव न हो जो एंट्री केवल ब्राउज़र में लोड करता है।
| फ़ाइलें | डेटाबेस + एडमिन | |
|---|---|---|
| कौन प्रकाशित कर सकता है | जो भी प्रोजेक्ट संपादित करे | एडमिन लॉगिन वाला कोई भी |
| सेटअप | न्यूनतम | लॉगिन, स्टोरेज, एडमिन UI |
| SEO | आसान (प्री-रेंडर्ड पेज) | ध्यान चाहिए ताकि पेज सर्वर पर या प्री-रेंडर होकर रेंडर हों |
| शेड्यूलिंग | डिप्लॉय पर प्रकाशित | तारीख के हिसाब से शेड्यूल कर सकते हैं |
| होस्टिंग लागत | स्टैटिक | चलता हुआ ऐप और डेटाबेस चाहिए |
ऐसी एंट्री लिखें जिन्हें लोग पढ़ें
- फ़ायदे से शुरू करें। “रिपोर्ट Excel में एक्सपोर्ट करें” बेहतर है “नया एक्सपोर्ट मॉड्यूल” से।
- बताएँ कि यह किसे मिलता है। सभी प्लान, केवल Pro, इस हफ़्ते रोलआउट हो रहा है।
- दिखाएँ। एक स्क्रीनशॉट या छोटी क्लिप।
- छोटे सुधारों को समूह बनाएँ। हर हफ़्ते “Fixes and improvements” एंट्री, बुलेट के साथ, ताकि पेज भर न जाए।
- हटाए गए फ़ीचर के बारे में ईमानदार रहें। अगर कोई चीज़ जा रही है, तो बताएँ कब और उसकी जगह क्या इस्तेमाल करें।
एक काम करने वाला पहला प्रॉम्प्ट
हमारी साइट पर /changelog पर एक सार्वजनिक चेंजलॉग जोड़ो। हर एंट्री एक Markdown फ़ाइल है जिसमें शीर्षक, तारीख, टैग (New, Improved या Fixed), वैकल्पिक कवर इमेज और मुख्य भाग हो। इंडेक्स पेज एंट्री को सबसे नई पहले सूचीबद्ध करे, तारीख, टैग और पहले पैराग्राफ़ के साथ, टैग फ़िल्टर बटन हों, और हर पेज पर 10 एंट्री दिखें। हर एंट्री का अपना पेज /changelog/<slug> पर हो, सर्च इंजन के लिए उचित पेज शीर्षक और विवरण के साथ। /changelog/rss.xml पर एक RSS फ़ीड जोड़ो। तीन सैंपल एंट्री बनाओ। मौजूदा साइट के डिज़ाइन से मेल खाओ, फ़ोन पर पढ़ने योग्य रखो, और पेज प्री-रेंडर करो ताकि वे तेज़ लोड हों।
डेटाबेस वाले संस्करण के लिए पहले वाक्य की जगह यह लिखें: “एंट्री को ड्राफ़्ट/प्रकाशित स्टेटस और प्रकाशन तारीख के साथ डेटाबेस में रखो, और उन्हें लिखने, प्रीव्यू करने और प्रकाशित करने के लिए पासवर्ड-सुरक्षित एडमिन पेज जोड़ो।”
बनाने के चरण
- ऊपर की तालिका से तय करें: फ़ाइलें या डेटाबेस।
- इंडेक्स और एंट्री पेज बनाएँ कुछ सैंपल एंट्री के साथ।
- टैग और फ़िल्टर जोड़ें।
- RSS फ़ीड जोड़ें और उसे पेज से लिंक करें।
- हर एंट्री के लिए पेज शीर्षक, विवरण और साइटमैप में प्रविष्टि जोड़ें। बुनियादी बातों के लिए AI से बनी वेबसाइटों के लिए SEO गाइड देखें।
- एडमिन पेज और लॉगिन, अगर आपने डेटाबेस वाला रास्ता चुना है।
- अपने ऐप में “नया क्या है” बैज।
- पिछले कुछ महीनों की असली एंट्री लिखें, ताकि पेज खाली लॉन्च न हो।
आम गलतियाँ
- कमिट संदेश कॉपी करना। यूज़रों के लिए लिखें, डेवलपरों के लिए नहीं।
- प्रति-एंट्री URL के बिना एक विशाल पेज। कोई एक खास बदलाव लिंक नहीं कर सकता, और सर्च इंजन एक पेज देखते हैं, कई नहीं।
- एक महीने बाद अपडेट बंद हो जाना। एक साल से अपडेट न हुआ चेंजलॉग संकेत देता है कि प्रोडक्ट छोड़ दिया गया है। ऐसी लय तय करें जिसे आप निभा सकें।
- केवल ब्राउज़र में एंट्री लोड करना। सर्च इंजन और लिंक प्रीव्यू खाली पेज देख सकते हैं। प्री-रेंडर या सर्वर-रेंडर करें।
- घटनाओं (incidents) को मिलाना। आउटेज स्टेटस पेज पर जाते हैं, चेंजलॉग पर नहीं।
कब होस्टेड चेंजलॉग टूल बेहतर विकल्प है
होस्टेड चेंजलॉग और प्रोडक्ट-अपडेट टूल मौजूद हैं, और कुछ फ़ीडबैक बोर्ड या ऐप के विजेट के साथ आते हैं। वे उपयोगी हैं अगर आप बिना बनाए ऐप के अंदर पॉपअप, दर्शक-लक्षित करना और एनालिटिक्स चाहते हैं, या अगर आपकी टीम पहले से एक ऐसा टूल खरीदती है जिसमें यह शामिल है। आपके ब्लॉग या हेल्प सेंटर सॉफ़्टवेयर में भी पहले से उपयुक्त फ़ॉर्मेट हो सकता है।
अपना बनाना तब समझदारी है जब आप चेंजलॉग अपने डोमेन पर, अपने डिज़ाइन में, और पूरी तरह इंडेक्स होने योग्य चाहते हैं, जो तारीख वाली पोस्ट की सादी सूची के लिए ज़्यादा काम नहीं है।
Mythex के साथ बनाना
Mythex पर आप एजेंट से मौजूदा प्रोजेक्ट में चेंजलॉग जुड़वा सकते हैं, या इसे अपनी छोटी साइट के रूप में बनवा सकते हैं, और बनते हुए लाइव प्रीव्यू में देख सकते हैं। फ़ाइल-आधारित संस्करण को डेटाबेस नहीं चाहिए। अगर आप एडमिन वाला संस्करण चुनते हैं, तो जब एंट्री सहेजनी हों तब एजेंट एक समर्पित Postgres डेटाबेस जोड़ता है (या /database टाइप करें), और स्क्रीनशॉट प्रोजेक्ट फ़ाइल स्टोरेज में जाते हैं। एडमिन साइन-इन ऐसी चीज़ है जो आप अपने ऑथ तरीके से जोड़ते हैं (लॉगिन जोड़ने की रेसिपी)।
New Mythex ऐप अक्सर क्लाइंट-रेंडर्ड सिंगल-पेज ऐप होते हैं, और SEO रेसिपी बताती है कि वे सर्च के लिए कमज़ोर हैं, इसलिए अगर आप चाहते हैं कि एंट्री सर्च में मिलें तो स्टैटिक या प्री-रेंडर्ड चेंजलॉग पेज माँगें। वही रेसिपी शीर्षक, विवरण और साइटमैप भी समझाती है। अंतर्निहित चेंजलॉग वाले शुरुआती बिंदु के लिए प्रोडक्ट नॉलेज हब टेम्पलेट देखें।
सवाल
चेंजलॉग की एंट्री में क्या होना चाहिए?
एक तारीख, एक छोटा शीर्षक जो बताए कि यूज़र के लिए क्या बदला, कुछ वाक्य या बुलेट जो उसे समझाएँ, New, Improved या Fixed जैसा टैग, और वैकल्पिक रूप से एक स्क्रीनशॉट और अधिक विवरण का लिंक।
क्या चेंजलॉग को डेटाबेस चाहिए?
ज़रूरी नहीं। अगर एक-दो लोग अपडेट प्रकाशित करते हैं, तो एंट्री साइट में Markdown फ़ाइलों के रूप में रह सकती हैं और हर डिप्लॉय पर प्रकाशित हो सकती हैं। डेटाबेस तब इस्तेमाल करें जब गैर-तकनीकी लोगों को एडमिन पेज से एंट्री लिखनी और शेड्यूल करनी हो।
मुझे चेंजलॉग कितनी बार अपडेट करना चाहिए?
जब भी कुछ ऐसा बदले जो यूज़र ध्यान दें। कई छोटे प्रोडक्ट बदलावों को हफ़्ते या दो हफ़्ते में समूह बनाते हैं; ज़रूरी बात है एक स्थिर लय, ताकि पेज ज़िंदा लगे।
क्या चेंजलॉग SEO के लिए अच्छा है?
थोड़ा मदद कर सकता है: हर एंट्री किसी फ़ीचर के बारे में एक क्रॉल होने योग्य पेज है, और नियमित रूप से अपडेट होने वाला पेज सक्रिय प्रोडक्ट का संकेत देता है। हर एंट्री को अपना URL और वर्णनात्मक शीर्षक दें।