Saat seseorang menemukan freeware atau proyek open source, pertanyaan pertamanya sering sederhana: apa fungsinya, dan apakah ini cocok untuk kebutuhan saya? Saya ingin halaman proyek menjawabnya sebelum pembaca perlu mencari-cari informasi di tempat lain. Tautan unduhan tetap penting, tetapi konteks membuatnya lebih berguna.
Terangkan kegunaan dengan konkret
Deskripsi pembuka sebaiknya menyebut pekerjaan yang dibantu, bukan sekadar menyebut bahwa proyek ini ringan atau mudah digunakan. Jelaskan juga apa yang tidak dikerjakan alat tersebut agar orang tidak mengunduh dengan harapan yang keliru. Satu contoh penggunaan yang spesifik lebih membantu daripada sederet klaim umum.
Letakkan batasan di depan
Persyaratan sistem, platform yang didukung, status pengembangan, dan masalah yang sudah diketahui adalah bagian dari informasi dasar. Bila petunjuk instalasi masih terbatas, katakan dengan jelas alih-alih membiarkan pengguna menebak. Kejujuran seperti ini menghemat waktu kedua pihak dan memberi gambaran yang lebih akurat tentang keadaan proyek.
Buat jalur unduhan mudah ditemukan
Setelah konteksnya jelas, tempatkan tautan unduhan atau repositori di lokasi yang mudah dikenali dan beri label sesuai tujuannya. Sertakan informasi lisensi jika tersedia, serta petunjuk singkat tentang cara melaporkan masalah atau mengikuti pembaruan. Pembaca seharusnya tidak perlu menebak tautan mana yang mengarah ke berkas dan mana yang membuka dokumentasi.
Rawat halaman seiring proyek
Halaman proyek ikut berubah ketika berkas, petunjuk, atau dukungannya berubah. Saya akan memperlakukan catatan versi dan tautan sebagai bagian dari pekerjaan, bukan tambahan yang boleh dilupakan setelah rilis. Sebelum membagikan sebuah proyek, periksa lagi apakah orang baru bisa memahami kegunaan, batasan, dan langkah berikutnya dari satu halaman.