Sistem Umpan Balik Baru Akan Docs.microsoft.com
Posting ini ditulis oleh Rob Eisenberg, Senior Program Manager di tim docs.microsoft.com.
Misi Microsoft adalah memberdayakan setiap orang dan setiap organisasi di planet ini untuk mencapai lebih banyak hal. Ini adalah salah satu pertimbangan kami saat kami membangun docs.microsoft.com di atas platform GitHub terbuka. Hari ini, kami membawanya ke tingkat berikutnya dengan pindah ke sistem umpan balik dokumentasi berbasis GitHub baru.
Umpan Balik Konten di GitHub
Meskipun dokumentasi kami telah ada di GitHub sejak awal, mekanisme umpan balik konten kami telah menggunakan Livefyre untuk komentar pada artikel. Meskipun Livefyre adalah solusi komentar yang bagus, ternyata tidak mencukupi untuk kebutuhan spesifik kami, yaitu melacak, menetapkan pemilik, dan mempertahankan status masalah konten yang diangkat oleh pelanggan.
Kami mengeksplorasi sejumlah jalan untuk membuatnya lebih baik, tetapi satu pertanyaan yang telah memandu banyak pekerjaan kami tampaknya akan berkembang kembali: Jika dokumentasi kami diperlakukan seperti kode sumber terbuka, apa yang akan kita gunakan untuk menyelesaikan masalah ini? Jawaban atas pertanyaan tampak jelas: Masalah GitHub, jadi kami mulai bereksperimen dengan mengintegrasikan API GitHub lebih dalam ke halaman dokumentasi kami, mampu membangun sistem umpan balik penuh di atas infrastruktur GitHub.
Dengan sistem baru, Anda sekarang dapat membuat masalah GitHub langsung dari halaman konten, yang memungkinkan Anda berinteraksi dengan cara yang jauh lebih kaya dengan penulis dan tim produk. Lihat masalah dengan dokumen? Sampel kode yang buruk? Penjelasan yang membingungkan? Kelalaian kritis? Cukup gulir ke bagian bawah halaman dan pilih Berikan umpan balik dokumentasi.
Anda dapat melihat semua masalah terbuka dan tertutup yang terkait dengan dokumen, langsung dari halaman dokumentasi itu sendiri - dengan cara itu Anda selalu mengetahui kapan hal-hal diperbaiki dan diselesaikan:
Anda dapat berkomentar dan bahkan menambahkan reaksi masalah yang penting untuk Anda:
Sekarang, karyawan Microsoft dapat memanfaatkan kekuatan penuh Masalah GitHub untuk melakukan triase, merespons, merencanakan, dan memperbaiki masalah yang dilaporkan - dan Anda akan selalu memiliki visibilitas ke dalam prosesnya!
Contoh umpan balik dokumentasi
Katakanlah Anda mengajukan masalah GitHub untuk hyperlink rusak pada artikel. Tim kami akan melakukan triase masalah, menetapkan label, dan menetapkan pemilik untuk melakukan perbaikan (atau mengajukan pertanyaan tindak lanjut). Ketika pemilik mengirimkan permintaan pull yang memperbaiki masalah, Anda akan diberi tahu (berdasarkan pengaturan pemberitahuan GitHub Anda), bahwa masalah telah diselesaikan/ditutup, membuat siklus umpan balik yang berbudi luhur.
Selain itu, Anda dapat memanfaatkan semua kebaikan GitHub standar, seperti Markdown dalam komentar, langganan ke masalah individu atau seluruh repositori, umpan RSS aktivitas organisasi, @ sebutan, penerima tugas, dan banyak lagi! Kami percaya bahwa integrasi alat sumber terbuka yang lebih dalam akan menumbuhkan peluang baru untuk pertumbuhan dan kolaborasi komunitas.
Pemisahan Umpan Balik Produk
Salah satu masalah dengan sistem sebelumnya adalah campuran antara produk dan umpan balik dokumentasi dalam satu aliran - sangat sulit untuk triase dan tindak lanjut, ketika tidak semua item secara konsisten diberi label. Kami mengambil langkah maju untuk memperbaiki masalah ini dengan membuat cara yang jelas untuk memisahkan keduanya:
Dengan mengklik Berikan umpan balik produk, Anda sekarang akan dibawa langsung ke situs tempat tim produk yang terkait dengan halaman dokumentasi tertentu menangani umpan balik produk.
Roll-Out
Anda mungkin bertanya-tanya kapan sistem umpan balik akan ditayangkan. Kami telah menguji coba selama beberapa bulan sekarang untuk Visual Studio IDE dan dokumentasi Azure CLI . Mulai pertengahan Februari, kami akan mulai meluncurkan ini di semua docs.microsoft.com.
Umpan Balik Anda
Umpan balik Anda penting untuk kami, jadi kami ingin mendapatkan sistem baru ini ke tangan Anda dengan cepat. Meskipun ini adalah langkah kami berikutnya dalam meningkatkan umpan balik dan keterlibatan di platform kami, itu sama sekali bukan langkah terakhir kami. Pastikan untuk menyuarakan pemikiran Anda tentang perubahan yang di GitHub, atau tandai kami di Twitter.