Dalam cerita ini
Sebelum Mulai
- Fitur ini dirancang untuk situs Help Center dan Dokumentasi Produk. Fitur aktif otomatis untuk pilihan awal Software atau SaaS. Jenis situs lain tidak dapat menambahkannya.
- Anda memerlukan izin untuk mengelola pusat bantuan.
Langkah-langkah
- Buka Stories lalu pilih Release notes. Ini akan membuka daftar catatan rilis.
- Pilih New.
- Isi Title,
version, danreleasedOn, yaitu tanggal versi tersebut dirilis. Ketiganya wajib diisi. - Opsional: Summary, maksimal 1.000 karakter, dan Link ke halaman yang lebih panjang.
- Tambahkan satu baris untuk setiap perubahan pada bidang daftar. Pada formulir ini, daftar tersebut ditampilkan sebagai Moments. Pilih Kind: New, Improved, atau Fixed. Tulis penjelasannya maksimal 300 karakter. Anda bisa menambahkan hingga 100 baris.
- Masukkan catatan ke bagian hub yang sesuai, lalu publikasikan.
Formulir menampilkan bidang pendukung ini dengan nama singkatnya, seperti version dan releasedOn, bukan kalimat lengkap.
Perlu Diketahui
- Order. Catatan diurutkan mulai dari tanggal rilis yang paling baru.
- Per hub. Halaman tiap hub mencantumkan catatan dari bagian dan topiknya masing-masing.
- RSS. Pembaca dapat mengikuti changelog melalui feed. Feed ini berada di alamat yang berakhiran /help/release-notes.rss pada situs Anda.
- Data pencarian. Setiap catatan ditandai untuk mesin pencari sebagai artikel teknis beserta versinya. Tidak ada jaminan tampilan khusus pada hasil pencarian.
- Tulis untuk pembaca. Jelaskan apa saja perubahan yang berpengaruh bagi mereka dengan bahasa yang sederhana.
Pertanyaan
Pertanyaan umum
Apakah saya bisa menjadwalkan catatan rilis?
Bisa. Catatan rilis berbentuk entri seperti cerita, jadi Anda bisa menjadwalkan publikasinya nanti.
Bagaimana dengan masalah yang belum diperbaiki?
Gunakan Known issues and notices.