Desain ing Confluence

ВсСм ΠŸΡ€ΠΈΠ²Π΅Ρ‚!

Jenengku Masha, aku kerja dadi insinyur jaminan kualitas ing grup perusahaan Tinkoff. Karya QA melu akeh komunikasi karo wong sing beda-beda saka tim sing beda-beda, lan aku uga dadi manajer lan dosen program pendidikan, mula peta komunikasiku dadi amba. Lan ing sawetara titik aku mbledhos: Aku temen maujud sing aku ora bisa maneh, aku ora bisa, Aku ora bisa isi ing ton neraka tabel lan dokumen unreadable.

Desain ing Confluence


Mesthi saben sampeyan saiki mbayangno apa sing dakkandhakake, lan kringet adhem: dhaptar jeneng tanpa urutan abjad, tabel kanthi atusan kolom kanthi tata letak sing ora apik, tabel kanthi ewonan garis sing sampeyan kudu mbusak driji. ing setir mouse kanggo dipikir judhul, ton saka kaca instruksi unnumbered, atusan huruf sing dikirim kanggo saben liyane karo data sing kudu dianalisis lan sistematis lan diiseni menyang tabel sing padha ora bisa diwaca.

Desain ing Confluence

Dadi, nalika aku rada adhem, aku mutusake nulis artikel iki. Aku bakal pirembagan bab carane sampeyan bisa biasane (malah kadhangkala trep) njaga macem-macem dokumentasi non-produk. Muga-muga artikel kasebut bakal nyebar ing jaringan lan tingkat neraka ing departemen sing cedhak karo pembangunan bakal mudhun sethithik, lan wong (kalebu aku) bakal dadi luwih seneng.

Desain ing Confluence

Piranti

Dokumentasi produk asring disimpen bebarengan karo kode, sing apik. Lan dokumentasi non-produk biasane disimpen ing ngendi wae. Asring wong nyoba nggawa informasi saka macem-macem panggonan menyang Confluence, lan kita ora terkecuali. Dadi crita liyane babagan dheweke.

UmumΓ©, Confluence minangka mesin wiki canggih. Ngidini sampeyan nggarap data ing macem-macem jinis tampilan: teks kanthi format, tabel, macem-macem grafik. Iki minangka alat sing menarik lan kuat, nanging yen sampeyan ora ngerti carane masak, sampeyan bakal entuk mbucal dokumen liyane sing ora bisa diwaca. Aku bakal mulang sampeyan carane masak!

Desain ing Confluence

Makro

Meh kabeh sihir Confluence dibangun ing sekitar makro. Ana akeh macro, lan padha bisa digabungake karo saben liyane. Dheweke dibayar lan gratis, luwih akeh bakal ana macem-macem conto makro kanthi tautan menyang dokumentasi kanggo dheweke.

Antarmuka kanggo nggarap makro pancen gampang. Kanggo nambah makro, sampeyan kudu ngeklik plus lan pilih unsur sing dikarepake saka dhaptar.

Desain ing Confluence

Yen makro mandhiri, yaiku, ora mbutuhake sisipan barang liya ing njero dhewe, katon kaya blok.

Desain ing Confluence

Yen macro perlu soko nang kanggo bisa, iku katon kaya kothak.

Desain ing Confluence

Ing wektu sing padha, sampeyan bisa nyelehake akeh liyane sing dikarepake ing siji pigura, anggere ana logika ing piramida sampeyan.

Desain ing Confluence

Saben makro nduweni pratinjau: langsung nuduhake manawa sampeyan wis ngisi lan ngatur makro kanthi bener.

Cithakan

Saliyane makro, ana alat sing trep kanggo isi pra-isi - iki minangka cithakan.
Cithakan bisa digunakake nalika nggawe kaca: mung klik ing telung titik ing jejere tombol "Gawe" banjur pilih cithakan sing dikarepake.

Desain ing Confluence

Banjur kabeh isi sing ana ing cithakan bakal ditambahake menyang kaca sing digawe.

Sapa wae bisa nggawe kaca saka cithakan, nanging mung sing duwe hak nggawe utawa nyunting template dhewe sing bisa nggawe kaca. Sampeyan bisa nambah instruksi tambahan kanggo cithakan babagan carane kaca kudu maintained.

Desain ing Confluence

Tabel Piandel

Bener, minangka teknisi, aku seneng banget karo tabel lan bisa mbungkus meh kabeh informasi (sanajan ora mesthi efektif). Tabel dhewe cetha, kabentuk, keukur, gaib!

Desain ing Confluence

Nanging malah entitas apik banget minangka meja bisa ngrusak. Lan bisa kasil digunakake lan malah apik. More ing ngisor iki.

Filtering (plugin mbayar)

Sembarang tabel sing ora bisa diwaca sing gedhe bisa digawe rada kurang gedhe lan bisa diwaca kanthi nggunakake nyaring. Kanggo nindakake iki, sampeyan bisa nggunakake makro mbayar Filter Tabel.

Ing makro iki, sampeyan kudu nyurung meja (sanajan sing paling elek bisa uga, sing utama yaiku nyurung kabeh). Ing makro, sampeyan bisa milih kolom kanggo filter gulung mudhun, filter teks, numerik, lan filter tanggal.

Desain ing Confluence

Bayangake yen kabeh informasi babagan calon kabeh lowongan dicathet ing daftar tabel. Alami, unsorted - wong ora teka ing wawancara ing urutan abjad. Lan sampeyan kudu ngerti yen sampeyan wis diwawancarai pelamar tartamtu sadurunge. Sampeyan mung kudu nyelehake neraka iki ing makro filter, nambah filter teks kanthi jeneng mburi - lan voila, informasi kasebut ana ing layar sampeyan.

Desain ing Confluence

Wigati dicathet menawa nyaring tabel ageng bisa mengaruhi kinerja sistem lan wektu mbukak kaca, saΓ©ngga nglebokake tabel ageng ing panyaring minangka kruk sementara, luwih becik mbangun proses supaya wong ora kudu nggawe tabel gedhe sing ora bisa diwaca (an conto proses bakal ana ing pungkasan artikel).

Ngurutake (plugin mbayar)

Kanthi Magic Macro Filter Tabel sampeyan uga bisa nyetel ngurutake standar ing sembarang kolom lan nomer baris. Utawa klik ing sembarang kolom tabel sing dilebokake ing makro filter, lan ngurutake miturut kolom iki bakal kedadeyan.

Desain ing Confluence

Contone, sampeyan duwe meja sing padha karo pelamar lan sampeyan kudu nemtokake jumlah wawancara sing ditindakake ing sasi tartamtu - urut miturut tanggal lan bungah.

Tabel Pivot (plugin mbayar)

Saiki ayo pindhah menyang kasus sing luwih menarik. Mbayangno sing meja ageng lan sampeyan kudu ngetung soko ing. Mesthi, sampeyan bisa nyalin menyang Excel, ngetung apa sing dibutuhake lan ngunggah data bali menyang Confluence. Apa sampeyan bisa ngetrapake makro sapisan? "Tabel Pivot" lan entuk asil sing padha, mung dianyari.

Contone: sampeyan duwe tabel sing ngemot data kabeh karyawan - ing ngendi lokasi geografis lan posisi apa sing dicekel. Kanggo ngetung jumlah wong ing saben kutha, sampeyan kudu milih ing "Pivot Table" macro baris kang data dikumpulake (lokasi) lan jinis operasi (tambahan).

Desain ing Confluence

Alami, sampeyan bisa klompok miturut sawetara kritΓ©ria bebarengan, sampeyan bisa ndeleng kabeh kemungkinan ing dokumentasi.

Bagan (plugin mbayar)

Kaya sing dakkandhakake, ora saben wong seneng karo meja kaya aku. Sayange, akeh manajer ora seneng karo dheweke. Nanging kabeh wong seneng denah warna sing padhang.
Pencipta Confluence mesthi ngerti babagan iki (mesthi uga duwe panggedhe sing seneng karo laporan lan grafik, ing ngendi dheweke bakal tanpa). Mulane, sampeyan bisa nggunakake macro ajaib "Bagan saka tabel". Ing makro iki, sampeyan kudu nglebokake tabel poros saka paragraf sadurunge, lan voila - data abu-abu sing mboseni katon apik.

Desain ing Confluence

Alami, makro iki uga duwe setelan. Link menyang dokumentasi kanggo makro apa wae bisa ditemokake ing mode suntingan makro kasebut.

Gampang nglumpukake

Informasi saka paragraf sadurunge mbokmenawa ora dadi wahyu kanggo sampeyan. Nanging saiki sampeyan mesthi ngerti carane nggunakake makro, lan aku bisa nerusake menyang bagean sing luwih menarik saka artikel kasebut.

Desain ing Confluence

Label

Iku ala nalika wong nyimpen informasi ing siji artikel unstructured utawa tabel ageng. Malah luwih elek nalika bagean saka informasi iki ora mung ora bisa diwaca, nanging uga kasebar ing expanses Confluence. Begjanipun, iku bisa kanggo ngumpulake informasi kasebar ing sak panggonan. Kanggo iki sampeyan kudu nggunakake label (tag sing akrab karo kabeh wong ing jaringan sosial).

Desain ing Confluence

Sembarang jumlah tag bisa ditambahake menyang kaca apa wae. Ngeklik tag bakal nggawa sampeyan menyang kaca agregasi kanthi pranala menyang kabeh isi karo tag kasebut, uga sakumpulan tag sing gegandhengan. Tag sing gegandhengan yaiku sing kerep katon ing kaca sing padha.

Desain ing Confluence

Properti kaca

Sampeyan bisa nambah makro liyane sing menarik menyang kaca kanggo informasi struktur - "Properti Kaca". Ing njero, sampeyan kudu ngirim tabel rong kolom, sing pisanan bakal dadi kunci, lan sing nomer loro bakal dadi nilai properti. Kajaba iku, makro bisa didhelikake saka kaca supaya ora ngganggu maca isi kasebut, nanging kaca kasebut isih bakal ditandhani karo tombol sing dibutuhake.

Desain ing Confluence

Pay manungsa waΓ© menyang ID - iku trep kanggo nyetel kanggo nyumerepi macem-macem klompok properti ing kaca beda (utawa malah beda klompok saka properti ing siji kaca).

Laporan

Kanthi tag, sampeyan bisa ngumpulake laporan. Contone, makro Laporan Isi ngumpulake kabeh kaca kanthi tag tartamtu.

Desain ing Confluence

Nanging laporan sing luwih menarik yaiku makro Laporan Properti Kaca. Iku uga ngumpulake kabeh kaca karo set tartamtu saka tags, nanging ora mung dhaftar mau, nanging compiles tabel (apa sampeyan nyekel sambungan karo awal artikel?), Ing ngendi kolom minangka kunci saka properti kaca.

Desain ing Confluence

Pranyata tabel ringkesan informasi saka macem-macem sumber. Iku apik yen nduweni fitur sing trep: tata letak adaptif, ngurutake miturut kolom apa wae. Uga, tabel laporan kasebut bisa dikonfigurasi ing makro.

Desain ing Confluence

Nalika configuring, sampeyan bisa mbusak sawetara kolom saka laporan, nyetel negara gawan utawa nomer cathetan ditampilake. Sampeyan uga bisa nyetel ID properti kaca kanggo ndeleng mung informasi sing dibutuhake.

Contone, sampeyan duwe akeh kaca karyawan, kaca-kaca iki duwe set properti babagan wong: level apa, ing ngendi dheweke, nalika gabung karo tim, lan liya-liyane. Properti kasebut ditandhani id = karyawan_inf. Lan ana set properti liya ing kaca sing padha, sing ngemot informasi babagan wong minangka bagean saka tim: peran apa sing ditindakake wong kasebut, tim apa dheweke, lan liya-liyane. Properti kasebut ditandhani ID = team_inf. Banjur, nalika nyusun laporan, sampeyan mung bisa nampilake informasi kanggo siji utawa loro ID bebarengan - endi wae sing luwih trep.

Kaendahan saka pendekatan iki yaiku saben wong bisa ngumpulake tabel informasi sing dibutuhake, sing ora bakal nggawe duplikat lan bakal dianyari nalika kaca utama dianyari. Contone: pimpinan tim ora preduli nalika pangembang entuk kerja, nanging penting apa peran saben wong ing tim kasebut. Pimpinan tim bakal ngumpulake laporan babagan tim. Lan akuntan ora peduli sing nindakake peran apa, nanging posisi penting - dheweke bakal ngumpulake laporan babagan posisi kasebut. Ing kasus iki, sumber informasi ora bakal diduplikasi utawa ditransfer.

Proses pungkasan

Pandhuan

Dadi, kita bisa nggawe struktur lan ngumpulake informasi kanthi efektif ing Confluence kanthi nggunakake makro minangka conto. Nanging saenipun, sampeyan kudu nggawe manawa informasi anyar langsung kabentuk lan mlebu ing kabeh mekanisme agregasi wis digunakake.

Ing kene akeh makro lan template bakal nylametake. Kanggo nggawe wong nggawe kaca anyar kanthi format sing bener, sampeyan bisa nggunakake makro Gawe saka Cithakan. Nambah tombol menyang kaca, kanthi ngeklik kaca anyar digawe saka cithakan sing dibutuhake. Kanthi cara iki sampeyan nggawe wong langsung bisa ing format sing dibutuhake.

Desain ing Confluence

Ing cithakan sing ngidini sampeyan nggawe kaca, sampeyan kudu nambah label, makro "Kaca Properties" lan tabel properti sing dibutuhake sadurunge. Aku uga nyaranake nambahake pandhuan babagan nilai apa sing kudu diisi kaca lan nilai properti.

Desain ing Confluence

Banjur proses pungkasan bakal katon kaya iki:

  1. Sampeyan nggawe cithakan kanggo jinis informasi tartamtu.
  2. Ing cithakan iki, tambahake label lan properti kaca ing makro.
  3. Ing sembarang panggonan sing trep, nggawe kaca root kanthi tombol, kanthi ngeklik kaca anak digawe saka cithakan.
  4. Miwiti ing kaca root pangguna sing duweni potensi ngasilake informasi sing dibutuhake (miturut cithakan sing dikarepake, kanthi ngeklik tombol kasebut).
  5. Nglumpukake dhewe laporan babagan properti kaca liwat tag sing sampeyan nemtokake ing cithakan.
  6. Bungah: sampeyan duwe kabeh informasi sing dibutuhake ing format sing trep.

Desain ing Confluence

pitfalls

Minangka insinyur kualitas, aku bisa kanthi aman ujar manawa ora ana sing sampurna ing jagad iki. Malah tabel gaib ora sampurna. Lan ana pitfalls ing proses ndhuwur.

  • Yen sampeyan mutusake ngganti jeneng utawa komposisi properti kaca, sampeyan kudu nganyari kabeh obyek sing wis digawe supaya data kasebut ditarik kanthi bener menyang laporan ringkesan. Iki sedih, nanging ing sisih liya, sampeyan kudu mikir kanthi rinci babagan "arsitektur" set informasi sampeyan, sing minangka tugas sing menarik banget.
  • Sampeyan kudu nulis instruksi sing cukup babagan carane ngisi tabel informasi lan nggunakake tag. Nanging, ing sisih liya, sampeyan mung bisa mbuwang artikel iki ing kabeh wong sing bener.

Conto nyimpen dokumentasi non-produk

Liwat proses kasebut ing ndhuwur, sampeyan bisa ngatur panyimpenan meh kabeh informasi. Kaendahan pendekatan kasebut yaiku universal: yen pangguna wis biasa, dheweke mandheg nggawe kekacoan. Uga gedhe (nanging ora gratis) ditambah yaiku kemampuan kanggo ngumpulake macem-macem statistik kanthi cepet lan nggambar diagram sing apik.

Aku bakal menehi conto proses kita njaga informasi babagan tim.

Desain ing Confluence

Kanggo saben wong ing tim, kita mutusake nggawe kertu karyawan. Patut, kita duwe cithakan sing saben wong anyar nggawe kertu iki kanggo awake dhewe lan nyimpen kabeh informasi pribadhi ing kono.

Desain ing Confluence

Kaya sing sampeyan ngerteni, kita duwe tabel properti sing rinci lan langsung duwe pandhuan babagan cara njaga kaca iki. Sawetara tag dilebokake dening karyawan dhewe miturut pandhuane, ing cithakan mung sing utama: tag kertu kertu pegawe, tag arah arah-melu lan tag printah tim-qa.

AkibatΓ©, sawise kabeh wong wis nggawe kertu kanggo awake dhewe, tabel lengkap karo informasi karyawan dijupuk. Informasi iki bisa digunakake ing macem-macem titik. Manajer sumber bisa ngumpulake tabel umum kanggo awake dhewe, lan pimpinan tim bisa ngumpulake tabel perintah kanthi nambahake tag tim menyang pilihan kasebut.

Miturut tags, sampeyan bisa ndeleng ringkesan beda, contone, dening qa-upgrade-plan kabeh tugas kanggo pangembangan QA bakal ditampilake. Ing wektu sing padha, saben wong ing kertu karyawan nyimpen crita penting lan rencana pangembangan dhewe - dheweke nggawe kaca nested saka template rencana pembangunan.

Desain ing Confluence

kesimpulan

Simpen dokumentasi apa wae supaya sampeyan ora isin, lan pangguna ora lara banget!

Muga-muga artikel kasebut migunani lan pesenan bakal teka ing kabeh dokumentasi ing saindenging jagad.

Desain ing Confluence

Source: www.habr.com

Add a comment