Biasanya ada masalah dengan basis pengetahuan perusahaan untuk pengembang - entah itu berubah menjadi kekosongan, karena tidak ada motivasi untuk mengisinya dengan orang yang bertanggung jawab, atau balkon yang diisi dengan barang-barang dari apartemen Soviet, semua orang berkontribusi, tetapi mereka menulis secara acak, informasi dengan cepat menjadi usang, dan tidak selalu punya waktu untuk memperbarui.
Bagaimana cara menghindari ini, atau setidaknya mengurangi kemungkinan biaya? Bagaimana cara membuat basis perusahaan Anda hangat dan lampu? Saya akan mencoba menjawab.
Dokumentasi gaya kolaborasi
Ada semacam pendekatan, dokumentasi kolaboratif, awalnya muncul di bidang kedokteran, ketika keputusan untuk membuat diagnosis dibuat secara kolektif oleh pasien dan beberapa dokter.
Contoh nyata dalam bidang TI adalah Google Docs, Wiki, Github, sistem apa pun yang memiliki konvensi internal dan kemungkinan bekerja bersama dalam suatu proyek.
Idenya adalah untuk memasukkan pengembang, pakar, kritik dalam pekerjaan dokumentasi sedini mungkin, untuk mengidentifikasi kesenjangan bersama.
Mengapa ini perlu?
Pertama, mengurangi faktor bus adalah hambatan dalam pengetahuan perusahaan, di mana jumlah pemegang pengetahuan cenderung bersatu. Anda perlu mentransfer pengetahuan seperti itu dari kepala pengembang, dari papan tulis, tiket, percakapan di dapur menjadi satu ruang sehingga semua orang dapat bekerja dengannya dan berkontribusi.
Kedua, untuk menyederhanakan masuknya pendatang baru ke proyek, yang sangat penting bagi tim dan tim terdistribusi dengan sejumlah pengembang outsourcing, serta bagi perusahaan yang memiliki area bisnis yang sangat spesifik, peluang untuk menemukan spesialis yang sudah jadi adalah nol.
Ketiga, untuk pembentukan budaya perusahaan yang sehat, transparansi "tidak dengan kata-kata". Seorang pengembang di lingkungan seperti itu jelas memahami poin-poin pertumbuhan profesional, teknologi apa lagi yang bisa ia coba di perusahaan, apa yang harus dipelajari.
Apa yang harus dilakukan
Dokumentasi dalam basis pengetahuan perusahaan dapat ditulis oleh setiap anggota tim, perlu untuk menyederhanakan kesempatan ini bagi mereka, maka mereka akan merasa seperti pemilik hasil yang terlibat.
Namun, Anda pasti membutuhkan orang yang akan menjalankan fungsi arsitek informasi - menetapkan aturan, struktur, logika, gaya, menempatkan dokumen dalam ruang dengan benar.
Buka kemungkinan mengedit dan membuat dokumen untuk anggota tim, setelah sebelumnya menyetujui aturan permainan. Otomatiskan aturan-aturan ini secara maksimal - jangan mengandalkan tim, buat templat, tag konten secara otomatis dengan tag, konfigurasikan unggahan dari repositori ke basis pengetahuan (omong-omong, saya ingin membuat artikel terpisah tentang ini).
Adalah penting bahwa pengembang melihat bahwa dokumen tidak mati di Wiki perusahaan.
Sebuah prinsip penting: definisi dari dokumen internal, ini adalah momen ketika amandemen atau komentar dibuat untuk itu , yaitu, pada kenyataannya, momen kolaborasi. Ini nilainya, mereka ingin menghabiskan waktu untuk itu. Jangan menambah - ini berarti bahwa proses pengiriman, pelaksanaan pencarian tidak terorganisir dengan baik, atau alat tidak nyaman.
Masalah potensial dari pendekatan ini adalah akumulasi suntingan dan komentar sebagai bola salju, sulit untuk melacaknya, duplikat dokumen sering dibuat.
Untuk mencegah hal ini terjadi, Anda dapat dan harus: A. Mengatur tim ke vektor, seperangkat aturan dan mempersulit proses untuk tidak mengikutinya (misalnya, kami menyembunyikan tombol Buat di Confluence dan membuat pemilihan templat wajib). B. Untuk membatasi hak dengan bijak dan mengkonfigurasi proses pengeditan dengan nyaman bagi mereka yang bertanggung jawab atas arsitektur informasi.
Dan kemudian dunia yang sempurna akan datang
Pengembang tidak akan berhenti bertanya satu sama lain, termasuk yang bodoh dan berulang-ulang . Mereka tidak akan belajar menemukan semua jawaban di pangkalan pengetahuan sendiri. Kami memiliki humor internal ketika, karena keterbatasan indeks pencarian Confluence, pengembang tidak dapat menemukan sesuatu, mereka bertanya kepada saya sebagai arsitek informasi. Kami menyebutnya pencarian berbasis Sveta.
Terlepas dari keterbatasan ini, struktur dasar basis pengetahuan, penamaan halaman yang seragam, penggunaan label akan merangsang mereka untuk mencari dan menciptakan pengetahuan sehingga, misalnya, mereka tidak menjawab pertanyaan yang berulang terus-menerus.
Peretasan lain yang kami terapkan adalah untuk selalu menyertakan konteks bisnis dalam dokumen, bahkan jika itu adalah deskripsi perpustakaan atau kelas atau daftar periksa untuk suatu tugas, penting untuk memahami apa artinya ini bagi klien.
Sekarang untuk berlatih
Bagian selanjutnya adalah tentang "Bagaimana," fitur internal Confluence mana (ya, kami menggunakan tumpukan Atlassian) yang dapat digunakan untuk menerapkan prinsip-prinsip ini.
Pola
Kami telah membuat template siap pakai untuk berbagai jenis dokumen yang paling sering kami tulis - spesifikasi teknis, cara-cara, daftar periksa. Mereka dapat dikonfigurasi di panel ruang admin. Diperlukan templat sehingga saat membuat dokumen pengembang tidak melihat halaman kosong di depannya, ia sudah memiliki petunjuk tentang apa yang harus ditulis di bagian ini atau itu. Jika Anda ingin dokumen dari jenis tertentu jatuh ke dalam satu bagian dan meta-informasi ditampilkan pada mereka (ini nyaman, misalnya, untuk menggambarkan komponen-komponen produk yang kompleks atau satu set layanan-layanan mikro menurut satu skema), lalu buat cetak biru, ini seperti templat dengan kecepatan maksimum.
Di dalamnya kita mengatur tata letak halaman, pos, di mana ia hanya tinggal mengganti beberapa kata, header dengan status, gambar, tabel, blok kode, dan bahkan variabel.
Variabel adalah elemen konten pra-konfigurasi yang penting untuk editor dokumen lebih lanjut, misalnya, memasukkan teks atau memilih dari daftar.
Anda juga dapat menambahkan tag ke templat terlebih dahulu, jika ini merupakan jenis dokumen yang sempit, Anda dapat menyebut pengguna sebagai pengulas, misalnya, jika ada alur kerja yang jelas berdasarkan nama, Jira makro, dan melampirkan tiket dari Jira. Pengalaman kami menunjukkan bahwa hingga 80 persen tugas dapat ditutup dengan templat.
Tata Letak Halaman
Elemen penting lainnya adalah pembuatan halaman arahan yang dapat dimengerti dan indah di ruang tim. Untuk melakukan ini, kami menggunakan tata letak halaman dan Panel makro, Kolom dan Bagian.
Di bawah ini adalah contoh dari salah satu ruang tim pengembangan kami.
Gunakan nama halaman yang bersahabat. Seperti yang Anda ketahui, Confluence tidak mendukung nama halaman yang identik dalam ruang yang sama. Pertahankan nama halaman yang jelas, seperti
Nama buruk Python
Nama baik Python Styleguide untuk tim layanan internal
Label
Confluence memiliki beberapa keterbatasan pada algoritma pencarian yang terkait dengan pengindeksan konten. Dan untuk basis pengetahuan perusahaan, justru menemukan dan keterhubunganlah yang merupakan masalah yang paling mendesak. Kami memiliki seluruh artikel di basis pengetahuan yang disebut Cara mengalahkan Pencarian Pertemuan, jika Anda mau, saya akan membagikannya di komentar.
Untuk mengatasi keterbatasan ini, kami menggunakan sistem label. Bahkan, ini adalah tag yang menandai subjek konten, dan mengapa tag ini memungkinkan Anda untuk menggabungkan konten subjek tertentu di satu tempat dalam bentuk semacam Umpan RSS (Konten makro menurut Label). Jadi kami telah mengkonfigurasi indeks subjek.
Jika Anda sudah memiliki ratusan halaman dalam database, maka saya menyarankan Anda untuk mulai dengan latihan berikut:
- Lihat daftar semua label di URL berikut https: // <my-host-name> /labels/listlabels-alphaview.action.
- Temukan semua konten yang tidak ditandai dengan label apa pun di string pencarian lanjutan: type: halaman NOT labelText: [a TO z] BUKAN labelText: [0 TO 9].
Apa yang bisa kamu lakukan dan lakukan sekarang?
- Berikan pengembang hak untuk mengedit, tetapi dengan bijak.
- Pikirkan tentang struktur ruang perintah, buat halaman arahan yang nyaman.
- Kustomisasi templat.
- Gunakan label.
- Pergi dan edit dokumen orang lain atau tulis komentar, buat dokumen ini berfungsi.