Hello!
Nama saya Masha, saya bekerja sebagai jurutera jaminan kualiti dalam kumpulan syarikat Tinkoff. Kerja QA melibatkan banyak komunikasi dengan orang yang berbeza daripada pasukan yang berbeza, dan saya juga pernah menjadi pengurus dan pensyarah program pendidikan, jadi peta komunikasi saya adalah seluas mungkin. Dan pada satu ketika saya meletup: Saya menyedari bahawa saya tidak boleh lagi, saya tidak boleh, saya tidak boleh mengisi banyak jadual dan dokumen yang tidak boleh dibaca.
Pastinya setiap daripada anda kini membayangkan apa yang saya perkatakan, dan berpeluh sejuk: senarai nama keluarga tanpa susunan abjad, jadual dengan ratusan lajur dengan susun atur yang ceroboh, jadual dengan beribu-ribu baris di mana anda perlu memadamkan jari anda pada roda tetikus untuk melihat tajuk, banyak halaman arahan tidak bernombor, beratus-ratus surat yang dihantar kepada satu sama lain dengan data yang perlu dianalisis dan sistematik dan disumbat ke dalam jadual tidak boleh dibaca yang sama.
Oleh itu, apabila saya tenang sedikit, saya memutuskan untuk menulis artikel ini. Saya akan bercakap tentang cara anda biasanya (walaupun kadangkala dengan mudah) mengekalkan pelbagai dokumentasi bukan produk. Saya berharap artikel itu akan tersebar di rangkaian dan tahap neraka di jabatan-jabatan bersebelahan dengan pembangunan akan turun sekurang-kurangnya sedikit, dan orang (termasuk saya) akan menjadi lebih gembira.
Tools
Dokumentasi produk sering disimpan bersama kod, yang merupakan perkara yang baik. Dan dokumentasi bukan produk biasanya disimpan di mana-mana sahaja. Selalunya orang cuba membawa maklumat dari tempat yang berbeza ke Confluence, dan kami tidak terkecuali. Jadi selebihnya cerita tentang dia.
Secara umum, Confluence ialah enjin wiki termaju. Ia membolehkan anda bekerja dengan data dalam pelbagai jenis paparan: teks dengan pemformatan, jadual, pelbagai carta. Ini adalah alat yang sangat menarik dan berkuasa, tetapi jika anda tidak tahu cara memasaknya, maka anda akan mendapat satu lagi lambakan dokumen yang tidak boleh dibaca. Saya akan mengajar anda cara memasak!
Makro
Hampir semua keajaiban Confluence dibina di sekitar makro. Terdapat banyak makro, dan ia boleh digabungkan antara satu sama lain. Mereka berbayar dan percuma, seterusnya akan terdapat pelbagai contoh makro dengan pautan ke dokumentasi untuk mereka.
Antara muka untuk bekerja dengan makro adalah semudah mungkin. Untuk menambah makro, anda perlu mengklik pada tambah dan pilih elemen yang dikehendaki daripada senarai.
Jika makro itu berdikari, iaitu, ia tidak memerlukan penyisipan sesuatu yang lain di dalam dirinya, ia kelihatan seperti blok.
Jika makro memerlukan sesuatu di dalamnya untuk berfungsi, ia kelihatan seperti kotak.
Pada masa yang sama, anda boleh meletakkan seberapa banyak yang anda suka dalam satu bingkai, selagi terdapat logik dalam piramid anda.
Setiap makro mempunyai pratonton: ia serta-merta menunjukkan sama ada anda telah mengisi dan mengkonfigurasi makro dengan betul.
Templat
Selain makro, terdapat alat yang mudah untuk pra-pengisian kandungan - ini adalah templat.
Templat boleh digunakan semasa membuat sebarang halaman: cuma klik pada tiga titik di sebelah butang "Buat" dan pilih templat yang dikehendaki.
Kemudian semua kandungan yang ada dalam templat akan ditambah ke halaman yang dibuat.
Sesiapa sahaja boleh membuat halaman daripada templat, tetapi hanya mereka yang mempunyai hak untuk mencipta atau mengedit templat sendiri boleh membuat halaman. Anda boleh menambah arahan tambahan pada templat tentang cara halaman harus diselenggara.
Sihir Meja
Sebenarnya, sebagai seorang juruteknik, saya sangat menyukai jadual dan boleh membungkus hampir semua maklumat di dalamnya (walaupun ini tidak selalu berkesan). Jadual itu sendiri adalah jelas, berstruktur, berskala, ajaib!
Tetapi entiti yang indah seperti meja boleh rosak. Dan ia boleh digunakan dengan jayanya malah ditambah baik. Lebih lanjut mengenai itu di bawah.
Penapisan (pemalam berbayar)
Mana-mana jadual besar yang tidak boleh dibaca boleh dibuat sedikit kurang besar dan sedikit lebih mudah dibaca menggunakan penapisan. Untuk melakukan ini, anda boleh menggunakan makro berbayar .
Di dalam makro ini, anda perlu menolak meja (walaupun yang paling hodoh mungkin, perkara utama ialah menolaknya sepenuhnya). Dalam makro, anda boleh memilih lajur untuk penapis lungsur turun, penapis teks, angka dan penapis tarikh.
Bayangkan semua maklumat calon untuk semua kekosongan jawatan direkodkan dalam senarai jadual. Sememangnya, tidak disusun - orang tidak datang ke temu duga mengikut susunan abjad. Dan anda perlu faham jika anda pernah menemuduga pemohon tertentu sebelum ini. Anda hanya perlu meletakkan neraka ini dalam makro penapis, tambah penapis teks mengikut nama keluarga - dan voila, maklumat itu ada pada skrin anda.
Perlu diingat bahawa menapis jadual besar boleh menjejaskan prestasi sistem dan masa muat halaman, jadi meletakkan jadual besar dalam penapis adalah tongkat sementara, adalah lebih baik untuk membina proses di mana orang tidak perlu membuat jadual besar yang tidak boleh dibaca (dan contoh proses akan berada di akhir artikel).
Isih (pemalam berbayar)
Dengan Makro Ajaib anda juga boleh menetapkan pengisihan lalai pada mana-mana lajur dan nomborkan baris. Atau klik pada mana-mana lajur jadual yang dimasukkan ke dalam makro penapis, dan pengisihan mengikut lajur ini akan berlaku.
Sebagai contoh, anda mempunyai jadual yang sama dengan pemohon dan anda perlu memikirkan berapa banyak temu duga telah diadakan dalam bulan tertentu - susun mengikut tarikh dan bergembira.
Jadual Pangsi (pemalam berbayar)
Sekarang mari kita beralih kepada kes yang lebih menarik. Bayangkan jadual anda besar dan anda perlu mengira sesuatu di atasnya. Sudah tentu, anda boleh menyalinnya ke Excel, mengira apa yang anda perlukan dan memuat naik data kembali ke Confluence. Bolehkah anda menggunakan makro sekali? dan dapatkan hasil yang sama, hanya dikemas kini.
Contohnya: anda mempunyai jadual yang mengandungi data semua pekerja - di mana mereka berada secara geografi dan jawatan yang mereka pegang. Untuk mengira bilangan orang di setiap bandar, anda perlu memilih dalam makro "Jadual Pangsi" baris yang mana data diagregatkan (lokasi) dan jenis operasi (penambahan).
Sememangnya, anda boleh mengumpulkan mengikut beberapa kriteria sekaligus, anda boleh melihat semua kemungkinan .
Carta (pemalam berbayar)
Seperti yang saya katakan, tidak semua orang menyukai meja seperti saya. Malangnya, kebanyakan pengurus tidak menyukainya sama sekali. Tetapi semua orang suka carta warna terang.
Pencipta Confluence pasti tahu tentang perkara ini (pasti mereka juga mempunyai bos yang sukakan laporan dan carta, di manakah mereka tanpanya). Oleh itu, anda boleh menggunakan makro ajaib . Dalam makro ini, anda perlu meletakkan jadual pangsi dari perenggan sebelumnya, dan voila - data kelabu yang membosankan anda digambarkan dengan indah.
Sememangnya, makro ini juga mempunyai tetapan. Pautan ke dokumentasi untuk mana-mana makro boleh didapati dalam mod edit makro itu.
Kemudahan pengumpulan
Maklumat daripada perenggan sebelumnya mungkin bukan pendedahan untuk anda. Tetapi sekarang anda pasti tahu cara menggunakan makro, dan saya boleh beralih ke bahagian artikel yang lebih menarik.
Label
Adalah buruk apabila orang menyimpan maklumat dalam satu artikel tidak berstruktur atau jadual besar. Lebih teruk lagi apabila sebahagian daripada maklumat ini bukan sahaja tidak boleh dibaca, tetapi juga tersebar di seluruh kawasan Confluence. Nasib baik, adalah mungkin untuk mengumpul maklumat yang bertaburan di satu tempat. Untuk ini anda perlu menggunakan (tag yang biasa kepada semua orang di rangkaian sosial).
Sebarang bilangan teg boleh ditambah pada mana-mana halaman. Mengklik pada teg akan membawa anda ke halaman pengagregatan dengan pautan ke semua kandungan dengan teg tersebut, serta set teg yang berkaitan. Teg berkaitan ialah tag yang kerap muncul pada halaman yang sama.
Sifat halaman
Anda boleh menambah satu lagi makro yang menarik pada halaman untuk menstruktur maklumat - . Di dalamnya, anda perlu menyerahkan jadual dua lajur, yang pertama akan menjadi kunci, dan yang kedua akan menjadi nilai harta itu. Selain itu, makro boleh disembunyikan daripada halaman supaya ia tidak mengganggu membaca kandungan, tetapi halaman itu masih akan ditandakan dengan kekunci yang diperlukan.
Beri perhatian kepada ID - adalah mudah untuk menetapkannya untuk menggantung kumpulan sifat yang berbeza pada halaman yang berbeza (atau kumpulan sifat yang berbeza pada satu halaman).
laporan
Dengan tag, anda boleh mengumpul laporan. Contohnya, makro mengumpulkan semua halaman dengan set tag tertentu.
Tetapi laporan yang lebih menarik ialah makro . Ia juga mengumpulkan semua halaman dengan set teg tertentu, tetapi bukan sahaja menyenaraikannya, tetapi menyusun jadual (adakah anda menangkap sambungan dengan permulaan artikel?), Di mana lajur adalah kunci sifat halaman.
Ternyata jadual ringkasan maklumat daripada sumber yang berbeza. Ia bagus kerana ia mempunyai ciri yang mudah: susun atur penyesuaian, mengisih mengikut mana-mana lajur. Juga, jadual pelaporan sedemikian boleh dikonfigurasikan di dalam makro.
Semasa mengkonfigurasi, anda boleh mengalih keluar beberapa lajur daripada laporan, menetapkan keadaan lalai atau bilangan rekod yang dipaparkan. Anda juga boleh menetapkan ID sifat halaman untuk melihat maklumat yang anda perlukan sahaja.
Sebagai contoh, anda mempunyai banyak halaman pekerja, halaman ini mempunyai satu set sifat tentang seseorang: tahap mana dia, di mana dia, apabila dia menyertai pasukan, dan sebagainya. Sifat-sifat ini ditandakan id = pekerja_inf. Dan terdapat set kedua sifat pada halaman yang sama, yang mengandungi maklumat tentang seseorang sebagai sebahagian daripada pasukan: apakah peranan yang dilakukan oleh orang itu, dalam pasukan apa dia berada, dan sebagainya. Sifat-sifat ini ditandakan ID = team_inf. Kemudian, apabila menyusun laporan, anda boleh memaparkan hanya maklumat untuk satu atau dua ID sekali gus - yang mana lebih mudah.
Keindahan pendekatan ini ialah semua orang boleh mengumpul jadual maklumat yang mereka perlukan, yang tidak akan menduplikasi apa-apa dan akan dikemas kini apabila halaman utama dikemas kini. Sebagai contoh: seorang ketua pasukan tidak peduli apabila pembangunnya mendapat pekerjaan, tetapi adalah penting peranan yang dimainkan oleh setiap daripada mereka dalam pasukan. Ketua pasukan akan mengumpul laporan mengenai pasukan. Dan akauntan tidak peduli siapa yang melaksanakan peranan apa, tetapi jawatan itu penting - dia akan mengumpulkan laporan mengenai jawatan tersebut. Dalam kes ini, sumber maklumat tidak akan diduplikasi atau dipindahkan.
Proses akhir
Arahan
Jadi, kita boleh menstruktur dan mengagregatkan maklumat dengan berkesan dalam Confluence menggunakan makro sebagai contoh. Tetapi idealnya, anda perlu memastikan bahawa maklumat baharu distruktur serta-merta dan masuk ke dalam semua mekanisme pengagregatan yang sudah digunakan.
Di sini sekumpulan makro dan templat akan datang untuk menyelamatkan. Untuk mendapatkan orang ramai membuat halaman baharu dalam format yang betul, anda boleh menggunakan makro Cipta daripada Templat. Ia menambah butang pada halaman, dengan mengklik halaman baharu yang dibuat daripada templat yang anda perlukan. Dengan cara ini anda memaksa orang untuk bekerja dengan segera dalam format yang anda perlukan.
Dalam templat yang anda benarkan untuk membuat halaman, anda perlu menambah label, makro "Halaman Halaman" dan jadual sifat yang anda perlukan terlebih dahulu. Saya juga mengesyorkan menambah arahan tentang nilai yang perlu diisi halaman dan nilai harta.
Kemudian proses akhir akan kelihatan seperti ini:
- Anda sedang mencipta templat untuk jenis maklumat tertentu.
- Dalam templat ini, tambahkan label dan sifat halaman dalam makro.
- Di mana-mana tempat yang mudah, buat halaman akar dengan butang, dengan mengklik halaman kanak-kanak yang dibuat daripada templat.
- Mulakan pada halaman akar pengguna yang berpotensi menjana maklumat yang diperlukan (mengikut templat yang dikehendaki, dengan mengklik pada butang).
- Kumpulkan sendiri laporan tentang sifat halaman melalui teg yang anda tentukan dalam templat.
- Bergembiralah: anda mempunyai semua maklumat yang anda perlukan dalam format yang mudah.
Perangkap
Sebagai seorang jurutera yang berkualiti, saya dengan selamat boleh mengatakan bahawa tidak ada yang sempurna di dunia. Malah meja ilahi tidak sempurna. Dan terdapat perangkap dalam proses di atas.
- Jika anda memutuskan untuk menukar nama atau komposisi sifat halaman, anda perlu mengemas kini semua objek yang telah dibuat supaya datanya ditarik dengan betul ke dalam laporan ringkasan. Ini menyedihkan, tetapi sebaliknya, ia memaksa anda untuk berfikir secara terperinci tentang "seni bina" set maklumat anda, yang merupakan tugas yang sangat menarik.
- Anda perlu menulis sejumlah arahan yang baik tentang cara mengisi jadual maklumat dan menggunakan tag. Tetapi, sebaliknya, anda boleh membuang artikel ini kepada semua orang yang betul.
Contoh menyimpan dokumentasi bukan produk
Melalui proses yang diterangkan di atas, anda boleh mengatur penyimpanan hampir semua maklumat. Keindahan pendekatan ini ialah ia bersifat universal: apabila pengguna membiasakannya, mereka berhenti membuat kekacauan. Tambahan yang besar (tetapi tidak percuma) ialah keupayaan untuk mengumpul pelbagai statistik dengan cepat dan melukis gambar rajah yang cantik di atasnya.
Saya akan memberikan contoh proses kami mengekalkan maklumat tentang pasukan.
Untuk setiap orang dalam pasukan, kami memutuskan untuk mencipta kad pekerja. Sehubungan itu, kami mempunyai templat yang mengikutnya setiap orang baharu mencipta kad ini untuk dirinya sendiri dan menyimpan semua maklumat peribadinya di dalamnya.
Seperti yang anda lihat, kami mempunyai jadual terperinci hartanah dan serta-merta mempunyai arahan tentang cara untuk mengekalkan halaman ini. Beberapa teg diletakkan oleh pekerja sendiri mengikut arahan, dalam templat hanya yang utama: tag kad kad pekerja, tag arah arah-melibatkan dan tag arahan pasukan-qa.
Akibatnya, selepas semua orang membuat kad untuk diri mereka sendiri, jadual lengkap dengan maklumat mengenai pekerja diperolehi. Maklumat ini boleh digunakan di tempat yang berbeza. Pengurus sumber boleh mengumpul jadual umum untuk diri mereka sendiri dan ketua pasukan boleh mengumpul jadual arahan dengan menambahkan teg pasukan pada pemilihan.
Mengikut teg, anda boleh melihat ringkasan yang berbeza, contohnya, oleh qa-naik taraf-pelan semua tugasan untuk pembangunan QA akan dipaparkan. Pada masa yang sama, setiap orang dalam kad pekerjanya menyimpan cerita penting dan rancangan pembangunannya sendiri - dia mencipta halaman bersarang daripada templat rancangan pembangunan.
Kesimpulan
Simpan apa-apa dokumentasi dengan cara yang anda tidak malu dengannya dan pengguna tidak terluka dengan teruk!
Saya sangat berharap artikel itu berguna dan pesanan akan datang dalam semua dokumentasi dunia.
Sumber: www.habr.com