Membangun situs web yang indah dan fungsional itu sulit. Menunjukkan kepada klien Anda cara kerjanya bisa sama menantangnya.
Ada banyak cara untuk melakukan proses pendidikan klien. Sesi pelatihan – secara langsung atau melalui konferensi video – adalah pilihan yang populer. Mereka bisa informatif. Namun pengetahuan yang Anda bagikan mungkin tidak disimpan dalam jangka panjang. Dan tugas mencari melalui rekaman untuk satu tip tertentu juga tidak terlalu efisien.
Di situlah dokumentasi masuk. Ketika dikombinasikan dengan bentuk pelatihan yang lebih pribadi, ini memberikan referensi yang sangat baik yang dapat dilihat kembali oleh klien. Ini tidak hanya memperkuat pengetahuan klien; mereka juga dapat menggunakannya sebagai alat pengajaran untuk anggota tim masa depan.
Untuk desainer web, keindahannya ada dua. Pertama, Anda membantu seseorang mempelajari keterampilan yang berharga. Sama pentingnya, semakin banyak klien tahu, semakin kecil kemungkinan mereka mengganggu Anda dengan tugas-tugas kecil.
Dibutuhkan bakat, dan dokumentasi menulis tidak datang secara alami untuk semua orang. Tetapi Anda dapat meningkatkannya dengan latihan.
Hari ini, kami akan membagikan beberapa kiat untuk menulis dokumentasi situs web yang luar biasa. Jenis yang akan berterima kasih kepada klien Anda!
Fokus Pada Yang Penting
Situs web menjadi sangat kompleks. Teknologi seperti sistem manajemen konten (CMS), database, dan bahkan konfigurasi tanpa kepala adalah hal yang biasa. Seseorang berpotensi dapat menulis volume tentang bagaimana sebuah situs disatukan dan opsi yang menyertainya.
Namun, menulis dokumentasi yang sangat mendalam mungkin berlebihan. Ini mungkin mencakup item yang tidak relevan dengan klien Anda. Plus, perangkat lunak berubah seiring waktu. Masuk ke seluk beluk CMS dapat menyebabkan konten menjadi usang dalam waktu singkat.
Sebaliknya, fokuslah pada subjek yang paling penting bagi klien Anda. Pikirkan tentang tugas umum yang akan menjadi tanggung jawab mereka, dan jenis pertanyaan yang mungkin mereka ajukan. Ini adalah item yang kemungkinan besar perlu mereka rujuk saat Anda tidak ada.
Jika Anda ingin menambahkan konteks lebih lanjut, Anda juga boleh menambahkan tautan ke dokumentasi resmi – asalkan tidak terlalu teknis. Ini menyelamatkan Anda dari keharusan menemukan kembali roda sambil menawarkan sumber daya tepercaya lainnya untuk klien. Bahkan lebih baik lagi bahwa dokumentasi resmi kemungkinan akan berkembang seiring dengan perangkat lunak.
Jaga Teks Jelas dan Ringkas
Item yang Anda sertakan dalam dokumentasi situs web Anda harus ditulis dengan cara yang mudah dipahami klien. Oleh karena itu, penting untuk selalu mengingat tingkat pemahaman teknologi mereka saat menggabungkan berbagai hal.
Taruhan paling aman adalah menjaga semuanya tetap jelas dan ringkas. Dalam praktiknya, ini berarti petunjuk singkat dan sederhana untuk menyelesaikan sesuatu.
Dokumentasi yang dapat diserap pengguna dengan pandangan sekilas sangat ideal. Jika memungkinkan, hindari penjelasan yang bertele-tele. Semakin dekat mereka harus memeriksa apa yang Anda tulis, pengalaman mereka akan semakin membuat frustrasi.
Gunakan Isyarat Visual
Bagian lain dari menjaga hal-hal sederhana adalah penggunaan isyarat visual. Hal ini memungkinkan pembaca untuk memindai halaman dan dengan mudah memilih konsep-konsep kunci.
Namun tidak perlu khawatir – ini tidak memerlukan upaya besar dalam hal desain. Anda mungkin melakukannya dengan baik untuk menghindari sesuatu yang terlalu mewah atau rumit. Mereka cenderung menghalangi pengalaman membaca yang baik.
Dasar-dasar desain adalah semua yang Anda butuhkan di sini. Hal-hal seperti judul teks, daftar (terurut atau tidak berurutan), warna, dan ikon akan membantu. Anda mungkin tidak memerlukan apa pun selain yang disertakan dengan pengolah kata atau editor WYSIWYG favorit Anda.
Judul sangat bagus untuk memberikan beberapa pemisahan antara bagian konten. Dan daftar menawarkan format yang sempurna untuk petunjuk langkah demi langkah.
Bagaimanapun Anda memutuskan untuk menggunakan isyarat ini, penting untuk melakukannya secara konsisten. Misalnya, Anda dapat menunjukkan petunjuk bermanfaat dengan ikon bola lampu. Pembaca akan tahu untuk mencari waktu ini dan lagi dengan pemahaman instan tentang konteksnya.
Pilih Media yang Nyaman
Haruskah dokumentasi hidup online? Bagaimana dengan dokumen digital, seperti PDF? Mungkin itu harus dicetak di atas kertas?
Format online dan digital lainnya sangat bagus karena dapat diakses dari mana saja. Dan mereka juga yang paling mudah dirawat saat item perlu diperbarui. Plus, klien masih dapat mencetaknya jika mereka lebih suka hard copy.
Karena itu, keamanan juga harus menjadi perhatian untuk dokumen yang berisi informasi sensitif. Jika Anda membuat dokumentasi online, itu harus dikunci melalui login atau terbatas pada alamat IP tertentu. Dan jangan lupa untuk memblokir mesin pencari agar tidak mengindeks konten.
Ada baiknya juga berdiskusi dengan klien Anda tentang bagaimana mereka berencana untuk menggunakan sumber daya. Jika ini adalah proyek sederhana, mungkin file PDF kecil sudah cukup. Cari tahu apa yang paling cocok untuk mereka dan ciptakan sesuatu yang memenuhi kebutuhan mereka.
Bantu Klien Belajar dan Tumbuh
Dokumentasi dapat menjadi sarana yang sangat baik untuk membantu klien Anda memahami situs web mereka. Ini menyediakan sumber daya untuk mempelajari cara kerja berbagai hal, dan cara menyelesaikan tugas-tugas umum.
Jika Anda tidak yakin dengan kemampuan Anda untuk menulis secara efektif – jangan khawatir. Berikan upaya terbaik Anda, dan jangan takut untuk meminta umpan balik. Seiring waktu, Anda akan memiliki kesempatan untuk mengasah keahlian Anda.
Secara keseluruhan, ini adalah pembangun kepercayaan diri yang hebat bagi kedua belah pihak. Klien akan menjadi lebih nyaman mengelola situs web mereka. Sementara itu, Anda akan memiliki beberapa keterampilan mengajar yang serius yang dapat Anda bawa ke proyek-proyek masa depan.
