🕴🏼 🤦🏿 🙆🏼 Desain di Confluence 🔤 👋🏿 ❓

Halo semuanya!

Nama saya Masha, saya bekerja sebagai insinyur penjaminan 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, sehingga peta komunikasi saya selebar mungkin. Dan pada suatu saat saya meledak: Saya menyadari bahwa saya tidak bisa lagi, tidak bisa, tidak bisa mengisi banyak sekali tabel dan dokumen yang tidak dapat dibaca.

Tentunya Anda masing-masing sekarang membayangkan apa yang saya bicarakan dan menyapu keringat dingin: daftar nama keluarga tanpa urutan abjad, tabel ratusan kolom dengan tata letak yang telah bergerak keluar, tabel ribuan garis di mana Anda perlu menghapus jari Anda pada roda mouse untuk menonton menuju, berton-ton halaman instruksi yang tidak bernomor, ratusan surat data yang dikirim satu sama lain, yang harus dianalisis dan disistematisasikan dan dimasukkan ke dalam tabel yang tidak dapat dibaca yang sama.

Maka, ketika saya mulai kedinginan, saya memutuskan untuk menulis artikel ini. Saya akan berbicara tentang bagaimana Anda biasanya (bahkan kadang-kadang dengan mudah) dapat mempertahankan berbagai dokumentasi non-produk. Saya berharap bahwa artikel ini akan menyebar di seluruh jaringan dan tingkat iklan di departemen yang berdekatan dengan pengembangan akan sedikit berkurang, dan orang-orang (termasuk saya) akan menjadi sedikit lebih bahagia.

Alat

Dokumentasi produk sering disimpan dekat dengan kode, yang bagus. Dan dokumentasi non-produk biasanya disimpan di mana saja. Seringkali orang mencoba mentransfer informasi dari berbagai tempat ke Confluence, dan kami tidak terkecuali. Jadi keseluruhan cerita selanjutnya tentang dia.

Secara umum, Confluence adalah mesin wiki canggih. Ini memungkinkan Anda untuk bekerja dengan data dalam berbagai jenis tampilan: teks dengan pemformatan, tabel, berbagai diagram. Ini adalah alat yang sangat menarik dan kuat, tetapi jika Anda tidak tahu cara memasaknya, maka Anda akan mendapatkan tumpukan dokumen yang tidak dapat dibaca lagi. Saya akan mengajari Anda cara memasak!

Makro

Hampir semua sihir Confluence dibangun di atas makro. Ada banyak makro, dan mereka dapat dikombinasikan satu sama lain. Mereka dibayar dan gratis, maka akan ada contoh makro yang berbeda dengan tautan ke dokumentasi untuk mereka.

Antarmuka makro sesederhana mungkin. Untuk menambahkan makro, klik plus dan pilih item yang diinginkan dari daftar.

Jika makro swasembada, yaitu, itu tidak memerlukan penyisipan sesuatu yang lain di dalam dirinya, itu tampak seperti sebuah blok.

Jika agar makro berfungsi, Anda perlu meletakkan sesuatu di dalamnya, itu terlihat seperti bingkai.

Pada saat yang sama, Anda dapat menempatkan sebanyak mungkin yang Anda suka di dalam bingkai, jika saja ada logika di piramida Anda.

Setiap makro memiliki pratinjau: segera menunjukkan apakah Anda telah menyelesaikan dan mengkonfigurasi makro dengan benar.

Pola

Selain makro, ada alat yang nyaman untuk konten pra-isi - ini adalah templat.
Templat dapat digunakan saat membuat halaman apa pun: cukup klik pada tiga titik di sebelah tombol "Buat" dan pilih templat yang diinginkan.

Maka 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 itu sendiri. Anda dapat menambahkan instruksi tambahan ke template tentang cara mempertahankan halaman.

Sihir meja

Sebenarnya, sebagai seorang teknisi, saya sangat suka meja dan dapat membungkus hampir semua informasi di dalamnya (meskipun ini tidak selalu efektif). Tabel itu sendiri jelas, terstruktur, terukur, ajaib!

Tetapi bahkan entitas yang luar biasa seperti meja dapat dihancurkan. Dan Anda dapat berhasil menggunakan dan bahkan meningkatkan. Tentang itu di bawah ini.

Pemfilteran (plugin berbayar)

Tabel besar yang tidak dapat dibaca dapat dibuat sedikit kurang besar dan sedikit lebih mudah dibaca dengan memfilter. Untuk melakukan ini, Anda dapat menggunakan makro "tabel filter" berbayar .

Di dalam makro ini Anda harus menempel tabel (Anda bahkan dapat yang paling jelek, yang paling penting adalah mendorongnya secara keseluruhan). Di makro, Anda bisa memilih kolom untuk filter dengan daftar turun bawah, filter teks, filter numerik, dan filter berdasarkan tanggal.

Bayangkan saja semua informasi tentang kandidat untuk semua lowongan dicatat dalam daftar tabel. Secara alami, tidak disortir - orang tidak datang untuk wawancara berdasarkan abjad. Dan Anda perlu memahami jika Anda telah mewawancarai pelamar pekerjaan tertentu sebelumnya. Anda hanya perlu memasukkan neraka ini ke dalam filter makro, tambahkan filter teks dengan nama belakang - dan voila, informasi di layar Anda.

Perlu dicatat bahwa memfilter tabel besar dapat memengaruhi sistem dan waktu pemuatan halaman, jadi menempatkan tabel besar dalam filter adalah penopang sementara, lebih baik untuk membangun proses di mana orang tidak harus membuat tabel besar yang tidak dapat dibaca (contoh prosesnya akan berada di akhir artikel).

Sortir (plugin berbayar)

Menggunakan makro ajaib "Filter Tabel" Anda juga dapat mengatur penyortiran default dengan kolom apa saja dan beri nomor baris. Atau klik kolom mana saja dari tabel yang muncul ke makro filter, dan pengurutan menurut kolom ini akan terjadi.

Misalnya, Anda memiliki tabel yang sama dengan pelamar dan Anda perlu mencari tahu berapa banyak wawancara dilakukan pada bulan tertentu - urutkan berdasarkan tanggal dan berbahagialah.

Tabel ringkasan (plugin berbayar)

Sekarang mari kita beralih ke case yang lebih menarik. Bayangkan meja Anda sangat besar dan Anda perlu menghitung sesuatu darinya. Tentu saja, Anda dapat menyalinnya ke Excel, menghitung apa yang Anda butuhkan dan mengunggah data kembali ke Confluence. Atau Anda bisa menerapkan makro "Tabel Pivot" sekali dan mendapatkan hasil yang sama, tetapi juga diperbarui.

Misalnya: Anda memiliki tabel di mana data semua karyawan dikumpulkan - di mana mereka berada secara geografis dan posisi apa yang mereka tempati. Untuk menghitung berapa banyak orang di setiap kota, Anda harus memilih dalam "tabel Ringkasan" makro garis di mana data (lokasi) dan jenis operasi (agregasi) dikumpulkan.

Secara alami, Anda dapat mengelompokkan berdasarkan beberapa kriteria sekaligus, semua fitur dapat ditemukan dalam dokumentasi .

Grafik (plugin berbayar)

Seperti yang saya katakan, tidak semua orang menyukai meja seperti saya. Sayangnya, kebanyakan dari mereka tidak menyukai manajer sama sekali. Tetapi semua orang menyukai bagan warna yang cerah.
Pencipta Confluence, tentu saja, tahu tentang ini (mereka mungkin juga memiliki bos yang suka laporan dan bagan, tetapi di mana tanpanya). Oleh karena itu, Anda dapat menggunakan makro ajaib "Bagan dari tabel . " Dalam makro ini Anda harus meletakkan tabel pivot dari paragraf sebelumnya, dan voila - data membosankan abu-abu Anda divisualisasikan dengan indah.

Secara alami, makro ini juga memiliki pengaturan. Tautan ke dokumentasi untuk makro apa pun dapat ditemukan dalam mode pengeditan makro ini.

Kemudahan agregasi

Informasi dalam paragraf sebelumnya mungkin bukan wahyu untuk Anda. Tapi sekarang Anda pasti tahu cara menggunakan makro, dan saya bisa beralih ke bagian artikel yang lebih menarik.

Tag

Sangat buruk ketika orang menyimpan informasi dalam satu artikel yang tidak terstruktur atau meja besar. Lebih buruk lagi - ketika bagian dari informasi ini tidak hanya tidak dapat dibaca, tetapi juga tersebar di hamparan Confluence. Untungnya ada peluang untuk mengumpulkan informasi yang tersebar di satu tempat. Untuk melakukan ini, gunakan tag ( tag yang dikenal semua orang di jejaring sosial).

Anda dapat menambahkan sejumlah tag ke halaman mana pun. Jika Anda mengklik tag, Anda akan dibawa ke halaman agregasi, di mana ada tautan ke semua materi dengan tag ini, serta dengan serangkaian tag terkait. Tag terkait adalah tag yang sering ditemukan pada halaman yang sama.

Properti Halaman

Anda dapat menambahkan makro lain yang menarik ke halaman untuk menyusun informasi - “Properti Halaman” . Di dalamnya, Anda perlu mengirimkan tabel dua kolom, yang pertama adalah kunci, dan yang kedua adalah nilai properti. Selain itu, makro dapat disembunyikan dari halaman sehingga tidak mengganggu pembacaan konten, tetapi pada saat yang sama halaman akan tetap ditandai dengan tombol yang diperlukan.

Perhatikan ID - lebih mudah 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 Laporan Konten mengumpulkan semua halaman dengan serangkaian tag tertentu.

Tetapi laporan yang lebih menarik adalah makro "Laporan Properti Halaman" . Itu juga mengumpulkan semua halaman dengan satu set label tertentu, tetapi tidak hanya menampilkan daftar mereka, tetapi mengkompilasi tabel (menangkap tautan ke awal artikel?), Di mana kolom adalah kunci untuk properti halaman.

Ternyata tabel ringkasan informasi dari berbagai sumber. Sangat menyenangkan karena memiliki fungsi yang mudah: tata letak adaptif, pengurutan berdasarkan kolom apa pun. Juga, tabel pelaporan seperti itu dapat dikonfigurasi di dalam makro.

Saat mengonfigurasi, Anda dapat menghapus beberapa kolom dari laporan, mengatur status default atau jumlah rekaman yang ditampilkan. Anda juga dapat mengatur ID properti halaman untuk hanya melihat informasi yang Anda butuhkan.

Misalnya, Anda memiliki banyak halaman karyawan, halaman-halaman ini memiliki seperangkat properti tentang seseorang: tingkat apa dia, di mana dia berada, ketika dia bergabung dengan tim, dan sebagainya. Properti ini ditandai dengan ID = employee_inf . Dan ada serangkaian properti kedua pada halaman yang sama yang mengumpulkan informasi tentang orang tersebut, sebagai bagian dari tim: peran apa yang dilakukan orang itu, di tim mana dia berada, dan sebagainya. Properti ini ditandai dengan ID = team_inf . Kemudian, ketika menyusun laporan, Anda hanya dapat menampilkan informasi tentang satu ID atau hanya dua ID sekaligus - karena lebih nyaman.

Keindahan dari pendekatan ini adalah bahwa setiap orang dapat mengumpulkan tabel informasi yang mereka butuhkan, yang tidak akan menduplikasi apa pun dan akan diperbarui ketika halaman utama diperbarui. Sebagai contoh: Timlidu tidak penting ketika pengembangnya mendapatkan pekerjaan, tetapi penting peran apa yang mereka masing-masing mainkan dalam tim. Timlid akan mengumpulkan laporan tentang tim. Dan akuntan tidak peduli siapa yang melakukan peran apa, tetapi pos itu penting - dia akan mengumpulkan laporan pada pos tersebut. Dalam hal ini, sumber informasi tidak akan digandakan atau ditransfer.

Proses akhir

Instruksi manual

Jadi, kita dapat dengan indah menyusun dan mengumpulkan informasi secara efisien dalam Confluence menggunakan makro sebagai contoh. Tetapi idealnya, perlu untuk memastikan bahwa informasi baru segera terstruktur dan jatuh ke dalam semua mekanisme agregasi yang sudah digunakan.

Di sini sekelompok makro dan templat akan datang untuk menyelamatkan. Untuk membuat orang membuat halaman baru dalam format yang tepat, Anda dapat menggunakan makro "Buat dari Templat". Dia menambahkan tombol ke halaman, dengan mengklik halaman baru yang dibuat dari template yang Anda butuhkan. Dengan demikian, Anda membuat orang segera bekerja dalam format yang Anda butuhkan.

Di templat tempat Anda membuat halaman, Anda perlu menambahkan label, "Halaman Properties" makro dan tabel properti yang Anda butuhkan di muka. Saya juga merekomendasikan menambahkan instruksi tentang nilai apa yang harus mengisi halaman, dan nilai properti.

Maka proses akhir akan terlihat seperti ini:

Anda membuat templat untuk informasi jenis tertentu.
Tambahkan tag dan properti halaman di makro ke templat ini.
Di tempat yang nyaman, buat halaman root dengan tombol, dengan mengklik di mana halaman anak dari template dibuat.
Luncurkan pada halaman root pengguna yang berpotensi menghasilkan informasi yang diperlukan (sesuai dengan templat yang diinginkan, dengan mengklik tombol).
Kumpulkan laporan tentang properti halaman melalui label yang Anda tentukan di templat.
Bersukacitalah: Anda memiliki semua informasi yang diperlukan dalam format yang mudah.

Batuan bawah laut

Sebagai seorang insinyur yang berkualitas, saya dapat dengan aman mengatakan bahwa tidak ada yang ideal di dunia. Bahkan meja ilahi tidak sempurna. Dan dalam proses di atas, ada jebakan.

Jika Anda memutuskan untuk mengubah nama atau komposisi properti halaman, Anda harus memperbarui semua objek yang sudah dibuat sehingga datanya ditarik dengan benar ke dalam laporan ringkasan. Ini menyedihkan, tetapi, di sisi lain, itu membuat Anda memikirkan "arsitektur" set informasi Anda secara terperinci, yang merupakan tugas yang sangat menarik.
Anda harus menulis sejumlah instruksi yang layak tentang cara mengisi tabel informasi dan menggunakan tag. Tetapi, di sisi lain, Anda bisa melempar semua orang yang tepat ke dalam artikel ini.

Contoh menyimpan dokumentasi non-produk

Melalui proses yang dijelaskan di atas, Anda dapat mengatur penyimpanan hampir semua informasi. Keindahan dari pendekatan ini adalah universal: ketika pengguna terbiasa, mereka berhenti membuat kekacauan. Juga plus besar (tetapi tidak gratis) adalah kemampuan untuk mengumpulkan berbagai statistik dengan cepat dan menggambar diagram yang indah di atasnya.

Biarkan saya memberi Anda contoh proses manajemen informasi tim kami.

Untuk setiap orang dalam tim, kami memutuskan untuk membuat kartu karyawan. Karenanya, kami memiliki template yang dengannya setiap orang baru membuat kartu ini untuk dirinya sendiri dan menyimpan semua informasi pribadi di dalamnya.

Seperti yang Anda lihat, kami memiliki tabel properti terperinci dan segera memiliki instruksi tentang cara mempertahankan halaman ini. Beberapa tag diletakkan oleh karyawan sendiri sesuai dengan instruksi, dalam template hanya yang utama: tag kartukartu karyawan , tag arah -direksi dan tag tim-qa .

Akibatnya, setelah semua orang membuat kartu untuk diri mereka sendiri, sebuah tabel lengkap dengan informasi tentang karyawan diperoleh. Informasi ini dapat digunakan di berbagai titik. Manajer sumber daya dapat mengumpulkan tabel umum untuk diri mereka sendiri, dan pemimpin tim dapat membuat tabel tim dengan menambahkan tag tim ke seleksi.

Anda dapat melihat ringkasan yang berbeda dengan tag, misalnya, dengan qa-upgrade-rencana semua tugas untuk pengembangan QA akan ditampilkan. Pada saat yang sama, setiap orang dalam kartu karyawannya memimpin cerita penting dan rencana pengembangannya - membuat halaman yang disematkan dari templat untuk rencana pengembangan.

Kesimpulan

Simpan dokumentasi apa pun agar tidak memalukan, dan pengguna tidak terluka luar biasa!

Saya benar-benar berharap artikel ini bermanfaat dan semua dokumentasi dunia akan tertata.

Desain di Confluence