Bagaimana kami mengukur kualitas dan efektivitas pengembangan dokumentasi. Latar belakang dan dasar-dasar. Laporan Yandex

Kata Svetlana Kayushina, kepala departemen dokumentasi dan lokalisasi.



Departemen dokumentasi kami telah melalui beberapa tahap pengembangan. Pertama ada seorang penulis teknis yang melakukan tugas-tugas pelanggan individu. Kemudian sekelompok penulis teknis dibentuk, yang menyelesaikan serangkaian tugas terbatas. Sekarang kami memiliki departemen produksi besar - sepenuhnya memenuhi kebutuhan perusahaan dalam dokumentasi.



Pada setiap tahap, persyaratan untuk pekerjaan departemen berubah dan metrik baru muncul untuk mengukur kualitas dokumentasi dan layanan untuk menyediakan layanan dokumentasi. Metrik membantu kami meningkatkan produk, proses, dan kualitas, serta menginformasikan tentang kegagalan secara tepat waktu.


Metrik pertama


Penulis teknis pertama dibutuhkan oleh Yandex untuk mendokumentasikan teknologi yang digunakan hampir semua pengembang. Informasi tentang itu ditransmisikan secara lisan satu sama lain, sehingga bagian itu pasti hilang atau terdistorsi.


Dokumentasi ditulis, pelanggan puas, jadi kami memutuskan untuk menguasai bidang lain. Kami mulai dengan deskripsi layanan yang sangat penting bagi bisnis: mereka digunakan oleh banyak karyawan perusahaan.


Pada tahap awal, pelanggan memberi kami tugas mendokumentasikan teknologi. Satu-satunya metrik adalah ketersediaan dokumentasi: itu ditulis atau tidak. Ketika seorang penulis teknis sendirian, kualitasnya dievaluasi oleh pelanggan sendiri. Ketika ada lebih banyak penulis, konsultan layanan bergabung dengan pelanggan, dan kami memeriksa kualitas dokumentasi di dalam departemen.



Aliran tugas terus meningkat, jadi ada masalah dengan mempertahankan satu tingkat kualitas. Penilaian pakar agak subyektif, tapi kami ingin independen.


Selain itu, pelanggan datang dengan tugas-tugas dengan kompleksitas yang berbeda-beda: misalnya, menangkap informasi yang diketahui oleh satu orang, atau menggambarkan teknologi kompleks untuk mengembangkan produk eksternal kami.


Semua ini menciptakan masalah tertentu, jadi kami membutuhkan sistem untuk memprioritaskan tugas dan menilai kualitas dokumentasi.


Metrik Dokumentasi Internal


Kami mulai mengumpulkan umpan balik dari pelanggan internal dan pembaca yang menggunakan dokumentasi untuk menyelesaikan masalah mereka. Sebagai contoh, seorang pelanggan dapat memberi tahu kami bahwa ia berhenti berkonsultasi dengan rekan-rekannya 10 jam seminggu dan sekarang melakukan pekerjaan utamanya dengan lebih produktif.


Kami bertanya kepada pembaca seberapa baik dokumentasi membantu mereka memecahkan masalah. Kehadiran terlacak: berapa banyak pengguna per minggu mengakses dokumen. Jika lebih dari angka tertentu, maka dokumen tersebut layak didukung.



Metode ini membutuhkan biaya yang signifikan dan akses langsung ke pelanggan. Dalam kondisi penggunaan dokumentasi secara massal, itu ternyata terlalu mahal dan tidak berlaku. Karena itu, ketika kami mulai mengembangkan dokumentasi untuk pengguna eksternal, masalah muncul.


Penonton telah bertambah, kami tidak memiliki akses langsung ke sana. Kami melacak ulasan di jejaring sosial dan permintaan dukungan teknis, tetapi ini tidak cukup. Saya harus membuat hipotesis tentang siapa pengguna kami untuk memenuhi kebutuhannya sebanyak mungkin. Untuk menilai perilaku pengguna dan kinerja produk, kami menggunakan Yandex.Metrica.


Pengembangan sistem metrik untuk dokumentasi eksternal



Tujuan bisnis tidak banyak berubah, tetapi muncul kondisi baru: kami harus mengatur dokumentasi untuk rilis resmi. Sekarang kami harus memenuhi tenggat waktu.


Kami terus menggunakan metrik sebelumnya, tetapi kehadiran dan penolakan layanan dokumentasi ditambahkan ke dalamnya. Mereka dilacak untuk layanan secara keseluruhan dan untuk dokumen individu.


Penulis teknis menggunakan data tambahan untuk meningkatkan kualitas dokumentasi:


  • analisis perilaku pengguna pada layanan,
  • peta panas dari klik,
  • penampil web
  • penilaian permintaan pencarian, dll.

Kemudian kami melanjutkan ke tahap produksi massal dan menjadi layanan untuk penyediaan layanan dokumentasi.


Dokumentasi Metrik Produksi Massal


Pada tahap ini, pelanggan dan manajemen memiliki persyaratan baru untuk departemen dokumentasi.


Pelanggan tertarik pada waktu dan penilaian kompleksitas tugas. Misalnya, mereka bertanya mengapa kami menulis dokumen selama dua minggu, bukan dua hari. Pada saat yang sama, mereka mengharapkan kualitas tinggi dari kami.


Manajemen tertarik pada justifikasi biaya. Untuk menyewa seseorang ke departemen, kami harus berdebat ini. Misalnya, kami dapat menunjukkan manfaat terukur dari sebuah dokumen jika itu menyelesaikan masalah bukan dari beberapa pengguna, tetapi beberapa ribu, dan mengurangi beban pada dukungan teknis.


Metrik statistik kami tidak lagi cukup untuk menjawab pertanyaan-pertanyaan ini.



Dalam konteks produksi massal, kami memiliki beberapa tugas utama:


  1. teknologi dokumen
  2. mengikuti rilis,
  3. memberikan tingkat kualitas yang tinggi.

Ini membutuhkan pendekatan terpadu untuk semua yang kami lakukan.


Selain itu, kami, sebagai layanan, harus mengevaluasi kualitas layanan kami. Kita perlu memahami seberapa puas pengguna dan manfaat apa yang didapat dari dokumentasi berkualitas tinggi.


Untuk mengembangkan sistem penilaian baru, kami melakukan penelitian dan menganalisis sejumlah besar sumber: total 136 metrik ditemukan. Selain fakta bahwa jumlah mereka terlalu banyak, tidak semuanya mudah diukur dan kita tidak membutuhkan semuanya. Karenanya, kami memilih metrik yang sesuai dengan kondisi kami.



Kami tertarik pada aspek-aspek penilaian berikut:


  1. Metrik desain dan bisnis adalah indikator efektivitas kualitas layanan secara keseluruhan. Mereka diperlukan untuk meningkatkan kepuasan pelanggan dan untuk memprediksi sumber daya departemen untuk melakukan semua tugas.
  2. Dokumentasikan metrik penilaian kualitas untuk meningkatkan kepuasan pengguna.

Saat memilih metrik, kami memperhitungkan kompleksitas dan biaya penghitungan metrik. Penting juga bagi kami bahwa esensi dan perhitungan metrik harus jelas bagi orang-orang yang tidak terbenam dalam nuansa proses produksi kami.


Hasilnya, kami memilih 20 dari 136 metrik, dan kemudian membaginya menjadi empat kelompok. Kami menampilkan data metrik pada dasbor yang tersedia untuk setiap karyawan perusahaan.



Pada bagian selanjutnya dari artikel ini, kami akan menjelaskan secara lebih rinci metrik untuk pengembangan dan dukungan dokumentasi dan bagaimana kami mempertimbangkannya. Mendaftar untuk komentar baru - kami akan memberi tahu Anda di dalamnya tentang rilis bagian selanjutnya dari laporan.

Source: https://habr.com/ru/post/id443900/


All Articles