DEV Community

Tobin Wetherell
Tobin Wetherell

Posted on

Menyusun skenario pembacaan dokumentasi dari positioning Orkvex

Sebelum menilai kelengkapan dokumentasi, saya ingin menentukan pekerjaan yang sedang dicoba oleh pembacanya.

Materi solusi Orkvex memberi konteks melalui pembagian peserta. Dari sana, kita dapat menyusun skenario pembacaan tanpa menebak perilaku sistem.

Format skenario

Saya menggunakan kalimat: “Seorang peserta ingin memperoleh hasil tertentu dan membutuhkan informasi tertentu.”

Contoh umum: seorang pengembang ingin menampilkan status proses dalam aplikasi dan perlu memahami arti setiap status.

Kalimat tersebut mengarah pada kebutuhan dokumentasi yang konkret: definisi, contoh, kondisi perubahan, dan penanganan situasi khusus.

Skenario bukan spesifikasi

Contoh yang kita tulis sendiri harus tetap diberi label sebagai ilustrasi. Ia belum menjadi bukti bahwa sebuah platform menyediakan fungsi yang dibayangkan.

Langkah berikutnya adalah mencocokkannya dengan dokumentasi yang benar-benar tersedia.

Hasil yang berguna

Metode ini menghasilkan daftar pertanyaan yang berhubungan langsung dengan pekerjaan pembaca.

Bagi saya, itulah cara produktif untuk melanjutkan kajian mengenai Orkvex: menghubungkan positioning publik dengan kebutuhan penjelasan teknis.

Top comments (0)