Cara Membina Halaman Changelog: Entri, Tag, RSS dan 'Apa yang Baharu'

Halaman changelog ialah senarai bertarikh tentang apa yang berubah dalam produk anda, yang terbaharu dahulu, ditulis untuk orang yang menggunakannya. Untuk membinanya, anda memerlukan entri dengan tarikh, tajuk yang jelas, penerangan ringkas dan tag (Baharu, Dipertingkat, Dibetulkan), halaman yang menyenaraikannya, URL berasingan bagi setiap entri, dan idealnya suapan RSS serta cara untuk memberitahu pengguna bahawa ada yang baharu. Ia antara perkara paling mudah yang boleh anda bina, dan keputusan utama ialah di mana entri disimpan: sebagai fail dalam laman anda, atau dalam pangkalan data dengan halaman pentadbir.

Mengapa changelog berbaloi

Changelog menunjukkan kepada pelanggan dan bakal pelanggan bahawa produk itu diselenggara. Ia memberi sokongan dan jualan satu pautan untuk dihantar apabila seseorang bertanya "adakah ia sudah boleh buat X?". Ia juga tempat untuk menutup gelung maklum balas: apabila permintaan yang diminta dilancarkan, entri changelog ialah yang anda tunjuk kepada orang. Jika anda menjalankan portal maklum balas pelanggan, pautkan permintaan yang sudah dilancarkan terus ke entrinya.

Changelog bukan sejarah commit dalaman anda. "Refactor perkhidmatan bil" tidak bermakna apa-apa kepada pengguna. "Invois kini memaparkan nombor VAT syarikat anda" bermakna.

Apa yang diperlukan oleh halaman

Kandungan bagi setiap entri

Halaman

• Indeks changelog: yang terbaharu dahulu, dengan penapis tag dan penomboran ringkas atau "muat lagi".
• Halaman entri: satu entri bagi setiap URL, supaya ia boleh dipautkan dan dikongsi.
• Suapan RSS atau Atom: membolehkan orang dan alat mengikuti kemas kini tanpa e-mel.
• Halaman pentadbir (hanya dalam versi pangkalan data): tulis, pratonton, jadualkan dan terbitkan entri.

Tambahan dalam apl

• Lencana "apa yang baharu": titik pada item menu apabila terdapat entri yang belum dilihat oleh pengguna. Simpan tarikh entri terakhir yang mereka buka, bagi setiap pengguna atau dalam pelayar.
• Ringkasan e-mel: ringkasan yang dihantar kepada pengguna yang memilih untuk menerimanya. Ini memerlukan pembekal penghantaran; lihat cara menghantar e-mel dari apl anda.

Keputusan utama: fail atau pangkalan data

Entri sebagai fail dalam laman

Setiap entri ialah fail Markdown dalam projek. Menerbitkan entri bermakna menambah fail dan melakukan deployment semula. Ini pendekatan yang paling ringkas dan paling teguh: tiada pangkalan data, tiada log masuk pentadbir, tiada yang perlu dilindungi, dan halaman boleh dipra-render supaya ia dimuatkan dengan pantas dan mudah dibaca oleh enjin carian.

Ia sesuai untuk pasukan yang penulis entrinya selesa meminta pembina AI atau menyunting fail.

Entri dalam pangkalan data dengan halaman pentadbir

Entri disimpan dalam jadual, dan halaman pentadbir persendirian membolehkan sesiapa dalam pasukan menulis, pratonton, menjadualkan dan menerbitkan. Ini sesuai untuk pasukan di mana pemasaran atau sokongan menulis kemas kini, atau apabila anda mahukan penerbitan berjadual atau entri khusus mengikut khalayak (contohnya, hanya tunjukkan ciri perusahaan kepada pelanggan perusahaan).

Kosnya ialah lebih banyak untuk dibina dan diselenggara: log masuk pentadbir, muat naik imej, dan memastikan halaman awam masih boleh dibaca oleh enjin carian, yang mungkin tidak berlaku pada halaman yang hanya memuatkan entri dalam pelayar.

Menulis entri yang dibaca orang

• Mulakan dengan manfaat. "Eksport laporan ke Excel" lebih baik daripada "Modul eksport baharu".
• Nyatakan siapa yang mendapatnya. Semua pelan, Pro sahaja, dilancarkan secara berperingkat minggu ini.
• Tunjukkannya. Satu tangkapan skrin atau klip pendek.
• Kumpulkan pembetulan kecil. Entri mingguan "Pembetulan dan penambahbaikan" dengan poin memastikan halaman tidak dibanjiri.
• Jujur tentang penyingkiran. Jika sesuatu akan dihentikan, nyatakan bila dan apa yang perlu digunakan sebagai gantinya.

Prompt pertama yang berfungsi

Tambahkan changelog awam pada laman kami di /changelog. Setiap entri ialah fail Markdown dengan tajuk, tarikh, tag (Baharu, Dipertingkat atau Dibetulkan), imej muka depan pilihan dan kandungan. Halaman indeks menyenaraikan entri yang terbaharu dahulu dengan tarikh, tag dan perenggan pertama, mempunyai butang penapis tag, dan memaparkan 10 entri setiap halaman. Setiap entri mempunyai halaman sendiri di /changelog/<slug> dengan tajuk dan penerangan halaman yang betul untuk enjin carian. Tambahkan suapan RSS di /changelog/rss.xml. Cipta tiga entri contoh. Padankan reka bentuk laman yang sedia ada, pastikan ia mudah dibaca pada telefon, dan pra-render halaman supaya ia dimuatkan dengan pantas.

Untuk versi pangkalan data, gantikan ayat pertama dengan "Simpan entri dalam pangkalan data dengan status draf/diterbitkan dan tarikh terbit, dan tambahkan halaman pentadbir yang dilindungi kata laluan untuk menulis, pratonton dan menerbitkannya."

Langkah membina

1. Putuskan fail atau pangkalan data menggunakan jadual di atas.
2. Bina halaman indeks dan entri dengan beberapa entri contoh.
3. Tambah tag dan penapis.
4. Tambahkan suapan RSS dan pautkannya dari halaman.
5. Tambah tajuk halaman, penerangan dan entri peta laman bagi setiap entri. Panduan kami tentang SEO untuk laman web yang dibina dengan AI meliputi asasnya.
6. Halaman pentadbir dan log masuk, jika anda memilih laluan pangkalan data.
7. Lencana "apa yang baharu" dalam apl anda.
8. Tulis entri sebenar untuk beberapa bulan terakhir supaya halaman tidak kosong semasa dilancarkan.

Kesilapan biasa

• Menyalin mesej commit. Tulis untuk pengguna, bukan pembangun.
• Satu halaman besar tanpa URL bagi setiap entri. Tiada siapa boleh memautkan kepada perubahan tertentu, dan enjin carian melihat satu halaman, bukan banyak.
• Kemas kini berhenti selepas sebulan. Changelog yang kali terakhir dikemas kini setahun lalu mencadangkan produk yang ditinggalkan. Tetapkan rentak yang boleh anda kekalkan.
• Memuatkan entri hanya dalam pelayar. Enjin carian dan pratonton pautan mungkin melihat halaman kosong. Pra-render atau render pada pelayan.
• Mencampurkan insiden. Gangguan perkhidmatan tergolong dalam halaman status, bukan changelog.

Bila changelog alat hosting lebih sesuai

Alat changelog dan kemas kini produk yang dihoskan wujud, dan sesetengahnya datang bersama papan maklum balas atau widget dalam apl. Ia berbaloi jika anda mahu popup dalam apl, penargetan khalayak dan analitik tanpa membinanya sendiri, atau jika pasukan anda sudah membayar untuk alat yang menyertakannya. Perisian blog atau pusat bantuan anda juga mungkin sudah mempunyai format yang sesuai.

Bina sendiri apabila anda mahukan changelog pada domain anda sendiri, dalam reka bentuk anda sendiri, dan boleh diindeks sepenuhnya - bagi senarai mudah entri bertarikh, ia tidak memerlukan banyak kerja.

Membina dengan Mythex

Di Mythex, anda boleh meminta ejen menambah changelog pada projek sedia ada atau membinanya sebagai laman kecil tersendiri, dan melihatnya dalam pratonton langsung semasa ia dibina. Versi berasaskan fail tidak memerlukan pangkalan data. Jika anda memilih versi pentadbir, ejen menambah pangkalan data Postgres khusus apabila entri perlu disimpan (atau taip /database), dan tangkapan skrin disimpan dalam storan fail projek. Log masuk pentadbir ialah sesuatu yang anda tambah dengan pendekatan auth anda sendiri (resipi tambah log masuk).

Apl Mythex baharu selalunya aplikasi halaman tunggal yang dirender di sebelah klien, yang menurut resipi SEO kurang kuat untuk carian, jadi minta halaman changelog statik atau dipra-render jika anda mahu entri ditemui dalam carian. Resipi yang sama meliputi tajuk, penerangan dan peta laman. Untuk titik permulaan dengan changelog terbina dalam, lihat templat pusat pengetahuan produk.

Soalan lazim