Hello!
Nama saya Masha, saya bekerja sebagai insinyur jaminan kualitas di grup perusahaan Tinkoff. Pekerjaan QA melibatkan banyak komunikasi dengan orang yang berbeda dari tim yang berbeda, dan saya juga seorang manajer dan dosen program pendidikan, jadi peta komunikasi saya seluas mungkin. Dan pada titik tertentu saya meledak: Saya menyadari bahwa saya tidak bisa lagi, saya tidak bisa, saya tidak bisa mengisi banyak sekali tabel dan dokumen yang tidak bisa dibaca.
Tentunya Anda masing-masing sekarang membayangkan apa yang saya bicarakan, dan berkeringat dingin: daftar nama keluarga tanpa urutan abjad, tabel dengan ratusan kolom dengan tata letak yang ceroboh, tabel dengan ribuan baris di mana Anda perlu menghapus jari Anda pada roda mouse untuk melihat judul, berton-ton halaman instruksi tak bernomor, ratusan surat dikirim satu sama lain dengan data yang perlu dianalisis dan disistematisasikan dan dimasukkan ke dalam tabel yang tidak dapat dibaca yang sama.
Jadi, ketika saya sedikit tenang, saya memutuskan untuk menulis artikel ini. Saya akan berbicara tentang bagaimana Anda biasanya (bahkan terkadang nyaman) memelihara berbagai dokumentasi non-produk. Saya berharap artikel itu akan tersebar di jaringan dan tingkat neraka di departemen yang berdekatan dengan pengembangan akan turun setidaknya sedikit, dan orang-orang (termasuk saya) akan menjadi sedikit lebih bahagia.
Alat
Dokumentasi produk sering disimpan bersama kode, yang merupakan hal yang baik. Dan dokumentasi non produk biasanya disimpan dimana saja. Seringkali orang mencoba membawa informasi dari berbagai tempat ke Confluence, dan kami tidak terkecuali. Jadi sisa ceritanya adalah tentang dia.
Secara umum, Confluence adalah mesin wiki tingkat lanjut. Ini memungkinkan Anda untuk bekerja dengan data dalam berbagai jenis tampilan: teks dengan pemformatan, tabel, berbagai bagan. Ini adalah alat yang sangat menarik dan kuat, tetapi jika Anda tidak tahu cara memasaknya, Anda akan mendapatkan tumpukan dokumen yang tidak dapat dibaca lagi. Aku akan mengajarimu cara memasak!
makro
Hampir semua keajaiban Confluence dibangun di sekitar makro. Ada banyak makro, dan bisa digabungkan satu sama lain. Mereka berbayar dan gratis, selanjutnya akan ada berbagai contoh makro dengan tautan ke dokumentasi untuk mereka.
Antarmuka untuk bekerja dengan makro sesederhana mungkin. Untuk menambahkan makro, Anda perlu mengklik plus dan memilih elemen yang diinginkan dari daftar.
Jika makro mandiri, yaitu, tidak memerlukan penyisipan sesuatu yang lain di dalamnya, itu terlihat seperti blok.
Jika makro membutuhkan sesuatu di dalamnya agar berfungsi, itu terlihat seperti sebuah kotak.
Pada saat yang sama, Anda dapat menempatkan sebanyak mungkin orang lain di dalam satu bingkai, selama ada logika di piramida Anda.
Setiap makro memiliki pratinjau: pratinjau langsung menunjukkan apakah Anda telah mengisi dan mengonfigurasi makro dengan benar.
Template
Selain makro, ada alat praktis untuk pra-pengisian konten - ini adalah template.
Templat dapat digunakan saat membuat halaman apa pun: cukup klik tiga titik di sebelah tombol "Buat" dan pilih templat yang diinginkan.
Kemudian semua konten yang ada di template akan ditambahkan ke halaman yang dibuat.
Siapa pun dapat membuat halaman dari template, tetapi hanya mereka yang memiliki hak untuk membuat atau mengedit template sendiri yang dapat membuat halaman. Anda dapat menambahkan instruksi tambahan ke template tentang bagaimana halaman harus dipelihara.
Sihir Meja
Sebenarnya, sebagai seorang teknisi, saya sangat menyukai tabel dan dapat menggabungkan hampir semua informasi di dalamnya (walaupun ini tidak selalu efektif). Tabelnya sendiri jelas, terstruktur, terukur, ajaib!
Tetapi bahkan entitas yang luar biasa seperti meja pun bisa rusak. Dan itu dapat berhasil digunakan dan bahkan ditingkatkan. Lebih lanjut tentang itu di bawah ini.
Memfilter (plugin berbayar)
Tabel besar yang tidak dapat dibaca dapat dibuat sedikit lebih kecil dan sedikit lebih mudah dibaca menggunakan pemfilteran. Untuk melakukan ini, Anda dapat menggunakan makro berbayar .
Di dalam makro ini, Anda perlu mendorong meja (bahkan yang paling jelek pun mungkin, yang utama adalah mendorongnya seluruhnya). Di makro, Anda dapat memilih kolom untuk filter drop-down, filter teks, numerik, dan filter tanggal.
Bayangkan saja semua informasi tentang kandidat untuk semua lowongan dicatat dalam daftar tabel. Secara alami, tidak disortir - orang tidak datang ke wawancara dalam urutan abjad. Dan Anda perlu memahami jika Anda pernah mewawancarai pelamar tertentu sebelumnya. Anda hanya perlu meletakkan neraka ini di makro filter, menambahkan filter teks dengan nama belakang - dan voila, informasinya ada di layar Anda.
Perlu dicatat bahwa memfilter tabel besar dapat memengaruhi kinerja sistem dan waktu muat halaman, jadi menempatkan tabel besar di filter adalah penopang sementara, lebih baik membangun proses di mana orang tidak harus membuat tabel besar yang tidak dapat dibaca (sebuah contoh prosesnya ada di akhir artikel).
Menyortir (plugin berbayar)
Dengan Makro Ajaib Anda juga dapat mengatur penyortiran default pada kolom mana pun dan memberi nomor baris. Atau klik pada kolom mana saja dari tabel yang dimasukkan ke dalam makro filter, dan pengurutan berdasarkan kolom ini akan terjadi.
Misalnya, Anda memiliki meja yang sama dengan pelamar dan Anda perlu mencari tahu berapa banyak wawancara yang dilakukan pada bulan tertentu - urutkan berdasarkan tanggal dan bergembiralah.
Tabel Pivot (plugin berbayar)
Sekarang mari beralih ke kasus yang lebih menarik. Bayangkan meja Anda sangat besar dan Anda perlu menghitung sesuatu di atasnya. Tentu saja, Anda dapat menyalinnya ke Excel, menghitung apa yang Anda perlukan, dan mengunggah kembali datanya ke Confluence. Bisakah Anda menerapkan makro sekali? dan mendapatkan hasil yang sama, hanya diperbarui.
Misalnya: Anda memiliki tabel yang berisi data semua karyawan - lokasi geografis mereka dan posisi apa yang mereka pegang. Untuk menghitung berapa banyak orang di setiap kota, Anda harus memilih di makro "Tabel Pivot" baris tempat data dikumpulkan (lokasi) dan jenis operasi (penambahan).
Secara alami, Anda dapat mengelompokkan menurut beberapa kriteria sekaligus, Anda dapat melihat semua kemungkinan .
Bagan (plugin berbayar)
Seperti yang saya katakan, tidak semua orang menyukai meja seperti saya. Sayangnya, sebagian besar manajer sama sekali tidak menyukai mereka. Tapi semua orang menyukai bagan warna cerah.
Pembuat Confluence pasti tahu tentang ini (pasti mereka juga punya bos yang suka laporan dan bagan, di mana mereka tanpa itu). Oleh karena itu, Anda dapat menggunakan makro ajaib . Dalam makro ini, Anda perlu meletakkan tabel pivot dari paragraf sebelumnya, dan voila - data abu-abu Anda yang membosankan divisualisasikan dengan indah.
Secara alami, makro ini juga memiliki pengaturan. Tautan ke dokumentasi untuk makro apa pun dapat ditemukan dalam mode edit makro tersebut.
Kemudahan agregasi
Informasi dari paragraf sebelumnya mungkin bukan wahyu untuk Anda. Tapi sekarang Anda pasti sudah tahu cara menggunakan makro, dan saya bisa melanjutkan ke bagian artikel yang lebih menarik.
Tags
Ini buruk ketika orang menyimpan informasi dalam satu artikel yang tidak terstruktur atau tabel besar. Lebih buruk lagi adalah ketika bagian dari informasi ini tidak hanya tidak dapat dibaca, tetapi juga tersebar di hamparan Confluence. Untungnya, dimungkinkan untuk mengumpulkan informasi yang tersebar di satu tempat. Untuk ini, Anda perlu menggunakan (tag yang akrab bagi semua orang di jejaring sosial).
Sejumlah tag dapat ditambahkan ke halaman manapun. Mengklik tag akan membawa Anda ke halaman agregasi dengan tautan ke semua konten dengan tag tersebut, serta sekumpulan tag terkait. Tag terkait adalah tag yang sering muncul di halaman yang sama.
Properti halaman
Anda dapat menambahkan makro lain yang menarik ke halaman untuk menyusun informasi - . Di dalamnya, Anda perlu mengirimkan tabel dua kolom, yang pertama adalah kuncinya, dan yang kedua adalah nilai propertinya. Selain itu, makro dapat disembunyikan dari halaman sehingga tidak mengganggu pembacaan konten, tetapi halaman tersebut akan tetap ditandai dengan kunci yang diperlukan.
Perhatikan ID - akan lebih mudah untuk mengaturnya untuk menggantung grup properti yang berbeda pada halaman yang berbeda (atau bahkan grup properti yang berbeda pada satu halaman).
laporan
Dengan tag, Anda dapat mengumpulkan laporan. Misalnya, makro mengumpulkan semua halaman dengan sekumpulan tag tertentu.
Tapi laporan yang lebih menarik adalah makro . Itu juga mengumpulkan semua halaman dengan sekumpulan tag tertentu, tetapi tidak hanya mencantumkannya, tetapi menyusun tabel (apakah Anda menangkap hubungannya dengan awal artikel?), Di mana kolom adalah kunci dari properti halaman.
Ternyata tabel ringkasan informasi dari berbagai sumber. Sangat menyenangkan memiliki fitur yang mudah digunakan: tata letak adaptif, pengurutan berdasarkan kolom mana pun. Juga, tabel pelaporan seperti itu dapat dikonfigurasi di dalam makro.
Saat mengonfigurasi, Anda dapat menghapus beberapa kolom dari laporan, menyetel status default, atau jumlah rekaman yang ditampilkan. Anda juga dapat mengatur ID properti halaman untuk hanya melihat informasi yang Anda perlukan.
Misalnya, Anda memiliki banyak halaman karyawan, halaman ini memiliki sekumpulan properti tentang seseorang: level apa dia, di mana dia, kapan dia bergabung dengan tim, dan seterusnya. Properti ini ditandai id = karyawan_inf. Dan ada kumpulan properti kedua di halaman yang sama, yang berisi informasi tentang seseorang sebagai bagian dari tim: peran apa yang dimainkan orang tersebut, di tim mana dia berada, dan seterusnya. Properti ini ditandai ID = tim_inf. Kemudian, saat menyusun laporan, Anda hanya dapat menampilkan informasi untuk satu atau dua ID sekaligus - mana yang lebih nyaman.
Keindahan dari pendekatan ini adalah setiap orang dapat mengumpulkan tabel informasi yang mereka butuhkan, yang tidak akan menduplikasi apa pun dan akan diperbarui saat halaman utama diperbarui. Misalnya: seorang pemimpin tim tidak peduli kapan pengembangnya mendapat pekerjaan, tetapi peran apa yang dimainkan masing-masing dari mereka dalam tim itu penting. Pemimpin tim akan mengumpulkan laporan tentang tim. Dan akuntan tidak peduli siapa yang melakukan peran apa, tetapi posisinya penting - dia akan mengumpulkan laporan tentang posisi tersebut. Dalam hal ini, sumber informasi tidak akan digandakan atau dialihkan.
Proses akhir
Pengajaran
Jadi, kita dapat menyusun dan mengumpulkan informasi secara efektif di Confluence menggunakan makro sebagai contoh. Namun idealnya, Anda perlu memastikan bahwa informasi baru segera disusun dan masuk ke semua mekanisme agregasi yang sudah digunakan.
Di sini sekumpulan makro dan templat akan datang untuk menyelamatkan. Untuk membuat orang membuat halaman baru dalam format yang tepat, Anda bisa menggunakan makro Buat dari Templat. Itu menambahkan tombol ke halaman, dengan mengklik di mana halaman baru dibuat dari template yang Anda butuhkan. Dengan cara ini Anda memaksa orang untuk segera bekerja dalam format yang Anda butuhkan.
Di templat tempat Anda mengizinkan untuk membuat halaman, Anda perlu menambahkan label, makro "Properti Halaman", dan tabel properti yang Anda perlukan sebelumnya. Saya juga merekomendasikan untuk menambahkan instruksi tentang nilai apa yang harus diisi halaman dan nilai properti.
Maka proses akhir akan terlihat seperti ini:
- Anda sedang membuat template untuk jenis informasi tertentu.
- Di templat ini, tambahkan label dan properti halaman di makro.
- Di tempat yang nyaman, buat halaman root dengan tombol, dengan mengklik halaman anak yang dibuat dari template.
- Mulai di halaman root pengguna yang berpotensi menghasilkan informasi yang diperlukan (sesuai dengan template yang diinginkan, dengan mengklik tombol).
- Kumpulkan sendiri laporan tentang properti halaman melalui tag yang Anda tentukan di template.
- Bersukacitalah: Anda memiliki semua informasi yang Anda butuhkan dalam format yang nyaman.
Jebakan
Sebagai seorang insinyur kualitas, saya dapat dengan aman mengatakan bahwa tidak ada yang sempurna di dunia ini. Bahkan meja dewa pun tidak sempurna. Dan ada jebakan dalam proses di atas.
- Jika Anda memutuskan untuk mengubah nama atau komposisi properti halaman, Anda harus memperbarui semua objek yang sudah dibuat agar datanya ditarik dengan benar ke dalam laporan ringkasan. Ini menyedihkan, tetapi di sisi lain, ini memaksa Anda untuk berpikir secara mendetail tentang "arsitektur" kumpulan informasi Anda, yang merupakan tugas yang sangat menarik.
- Anda harus menulis instruksi yang cukup banyak tentang cara mengisi tabel informasi dan menggunakan tag. Tapi, di sisi lain, Anda bisa melempar artikel ini ke semua orang yang tepat.
Contoh menyimpan dokumentasi non-produk
Melalui proses yang dijelaskan di atas, Anda dapat mengatur penyimpanan hampir semua informasi. Keindahan dari pendekatan ini adalah bersifat universal: begitu pengguna terbiasa, mereka berhenti membuat kekacauan. Juga nilai tambah yang besar (tetapi tidak gratis) adalah kemampuan untuk mengumpulkan berbagai statistik dengan cepat dan menggambar diagram yang indah di atasnya.
Saya akan memberikan contoh proses kami menjaga informasi tentang tim.
Untuk setiap orang dalam tim, kami memutuskan untuk membuat kartu karyawan. Karenanya, kami memiliki templat yang dengannya setiap orang baru membuat kartu ini untuk dirinya sendiri dan menyimpan semua informasi pribadinya di dalamnya.
Seperti yang Anda lihat, kami memiliki tabel properti terperinci dan segera memiliki petunjuk tentang cara memelihara halaman ini. Beberapa tag diletakkan oleh karyawan sendiri sesuai instruksi, di template hanya yang utama: tag kartu kartu karyawan, tanda arah keterlibatan arah dan tag perintah tim-qa.
Alhasil, setelah semua orang membuat kartu untuk dirinya sendiri, diperoleh tabel lengkap dengan informasi karyawan. Informasi ini dapat digunakan di berbagai titik. Manajer sumber daya dapat mengumpulkan tabel umum untuk diri mereka sendiri, dan pimpinan tim dapat mengumpulkan tabel perintah dengan menambahkan tag tim ke pilihan.
Berdasarkan tag, Anda dapat melihat ringkasan yang berbeda, misalnya menurut rencana-peningkatan-qa semua tugas untuk pengembangan QA akan ditampilkan. Pada saat yang sama, setiap orang di kartu karyawannya menyimpan cerita penting dan rencana pengembangannya sendiri - dia membuat halaman bersarang dari templat rencana pengembangan.
Kesimpulan
Simpan dokumentasi apa pun sedemikian rupa sehingga Anda tidak malu karenanya, dan pengguna tidak terluka parah!
Saya sangat berharap artikel ini bermanfaat dan ketertiban akan datang di semua dokumentasi dunia.
Sumber: www.habr.com