🥇Dizajniranje u Confluence

Pozdrav svima!

Zovem se Maša, radim kao inženjer kvalitete u grupi Tinkoff. QA posao zahtijeva puno komunikacije s raznim ljudima iz različitih timova, a ja sam također bila menadžer i predavač obrazovnih programa, tako da je moja komunikacijska mreža bila maksimalno široka. I u nekom trenutku eksplodirala sam: shvatila sam da više ne mogu, ne mogu, ne mogu ispunjavati paklene tone nečitljivih tablica i dokumenata.

Sigurno je svatko od vas sada zamislio ono o čemu govorim i oblili ste se hladnim znojem: liste prezimena bez abecednog reda, tablice s stotinu kolona s pomaknutim formatiranjem, tablice s tisućama redaka, u kojima morate trljati prst o kotačić miša da biste vidjeli naslov, tone stranica nepro numeriranih uputa, stotine poruka koje se šalju jedni drugima s podacima koje treba analizirati i sistematizirati te gurnuti u jednake nečitljive tablice.

I tako, kad sam se malo smirila, odlučila sam napisati ovaj članak. Pričat ću o tome kako se može normalno (čak i povremeno ugodno) voditi razne neproizvodne dokumentacije. Nadam se da će članak zaokružiti mrežu i razina pakla u obližnjim razvojnim odjelima barem malo opasti, a ljudi (uključujući i mene) postati malo sretniji.

Alati

Proizvodna dokumentacija obično se čuva uz kod, što je dobro. A neproizvodna dokumentacija obično se čuva gdje god stigne. Često ljudi pokušavaju prenijeti informacije iz raznih mjesta u Confluence, a nismo iznimka. Tako da će cijela daljnja priča biti o njemu.

Uglavnom, Confluence je napredni wiki sustav. Omogućava rad s podacima u različitim prikazima: formatirani tekst, tablice, razne dijagrame. To je vrlo zanimljiv i moćan alat, ali ako ne znate kako ga pripremiti, dobit ćete još jedan smećar nečitljivih dokumenata. Naučit ću vas kako ga pripremiti!

Makroi

Gotovo sva čarolija Confluencea temelji se na makroima. Postoji mnogo makroa i mogu se kombinirati međusobno. Ima ih i plaćenih i besplatnih, a slijede različiti primjeri makroa s poveznicama na dokumentaciju za njih.

Sučelje za rad s makroima je maksimalno jednostavno. Da biste dodali makro, morate pritisnuti plus i odabrati željeni element s popisa.

Ako je makro samodostatan, što znači da ne zahtijeva umetanje dodatnog sadržaja unutar sebe, izgleda kao blok.

Ako je potrebno nešto smjestiti unutar makra da bi on funkcionirao, izgleda kao okvir.

Možete unutar jednog okvira smjestiti koliko god želite drugih, sve dok u vašoj piramidi postoji logika.

Svaki makro ima pregled: odmah možete vidjeti jeste li ispravno ispunili i postavili makro.

Predlošci

Osim makroa, postoji i zgodan alat za predpunjenje sadržaja - to je predložak.
Predloške možete koristiti prilikom izrade bilo koje stranice: jednostavno kliknite na tri točke pored gumba 'Kreiraj' i odaberite željeni predložak.

Tada će sva sadržaj iz predloška biti dodan na stvorenu stranicu.

Stranice iz predložaka može izraditi svatko, a samo oni koji imaju ovlaštenja mogu stvarati ili uređivati same predloške. U predložak možete dodati dodatne upute o tome kako treba voditi stranicu.

Čarolija tablica

Zapravo, kao tehničar, nježno volim tablice i mogu gotovo svaku informaciju obraditi kroz njih (iako to nije uvijek učinkovito). Tablice su same po sebi jasne, strukturirane, skalabilne, čarobne!

Ali čak i tako divnu stvar kao što je tablica možete pokvariti. No, možete je uspješno iskoristiti i čak poboljšati. O tome više u nastavku.

Filtriranje (plaćeni dodatak)

Svaku ogromnu, nečitljivu tablicu možete učiniti malo manje ogromnom i nešto čitljivijom pomoću filtriranja. Za to možete koristiti plaćeni makro „Filtriraj tablice“.

Unutar ovog makra trebate smjestiti tablicu (možete čak i onu najružniju, samo je važno staviti je u cijelosti). U makru možete odabrati stupce za filtriranje s padajućim popisom, tekstualnog filtra, numeričkog i filtra prema datumima.

Zamislite da se sve informacije o kandidatima za sve radne pozicije zapisuju u tablični popis. Naravno, to nije sortirano — ljudi ne dolaze na razgovore po abecedi. A vi trebate shvatiti jeste li ranije obavili razgovor s određenim kandidatom. Samo trebate smjestiti ovaj kaos u makro filtra, dodati tekstualni filtar prema prezimenu — i voila, informacije su vam na ekranu.

Važno je napomenuti da filtriranje velikih tablica može utjecati na rad sustava i vrijeme učitavanja stranica, stoga je umetanje velike tablice u filtriranje privremeno rješenje; bolje je organizirati proces tako da se ljudima ne mora stvarati velike, teške za čitanje tablice (primjer procesa bit će na kraju članka).

Sortiranje (plaćeni dodatak)

Pomoću čarobnog makronaredbe „Filtriraj tablice“ također se može postaviti zadano sortiranje za bilo koju kolonu i numerirati redove. Ili kliknite na bilo koju kolonu u tablici koja je umetnuta u filtar, i doći će do sortiranja po toj koloni.

Na primjer, imate istu tablicu s kandidatima i trebate procijeniti koliko je intervjua održano u određenom mjesecu — sortirajte po datumu i uživajte.

Pivotne tablice (plaćeni dodatak)

Sada prelazimo na zanimljiviji slučaj. Zamislite da je vaša tablica ogromna i treba nešto izračunati na njoj. Naravno, možete je kopirati u Excel, izračunati potrebne podatke i prenijeti ih natrag u Confluence. Ali možete jednom upotrijebiti makronaredbu „Pivotna tablica“ i dobiti isti rezultat, samo još i ažuriran.

Na primjer, imate tablicu u kojoj su prikupljeni podaci svih zaposlenika — gdje se teritorijalno nalaze i koje pozicije obnašaju. Da biste izračunali koliko ljudi se nalazi u svakom gradu, trebate odabrati u makronaredbi „Pivotna tablica“ redak po kojem se agregiraju podaci (lokacija) i vrstu operacije (zbrajanje).

Naravno, možete grupirati prema više kriterija odjednom, sve mogućnosti možete vidjeti u dokumentaciji.

Dijagrami (plaćeni dodatak)

Kao što sam već spomenula, ne vole svi tablice toliko kao ja. Nažalost, većina menadžera ih uopće ne voli. Ali svi jako vole šarene i živopisne dijagrame.
Stvoritelji Confluencea o tome su, nesumnjivo, znali (sigurno imaju i oni nadredene koji vole izvještaje i dijagrame, kako bi drugačije). Stoga se možete poslužiti čarobnom makronaredbom „Dijagram iz tablice“. U ovu makronaredbu treba staviti pivotnu tablicu iz prethodnog stavka, i voilà — vaši sivi, dosadni podaci su lijepo vizualizirani.

Naravno, u ovoj makronaredbi također postoje postavke. Poveznicu na dokumentaciju za bilo koju makronaredbu možete pronaći u načinu uređivanja te makronaredbe.

Jednostavnost agregacije

Informacije iz prethodnih tačaka zasigurno nisu bile otkrovenje za vas. Ali sada sigurno znate kako koristiti makroe, a ja mogu preći na zanimljiviji deo članka.

Oznake

Loše je kada ljudi čuvaju informacije u jednom nestrukturiranom članku ili ogromnoj tabeli. Još gore je kada su delovi tih informacija ne samo loše formatirani, nego su i raspršeni po Confluence-u. Na sreću, postoji mogućnost da skupite raspršene informacije na jednom mestu. Za to treba iskoristiti oznake (poznate svima iz društvenih mreža tagovi).

Na svaku stranicu možete dodati neograničen broj oznaka. Ako kliknete na oznaku, doći ćete na stranicu agregacije, gde su povezani svi materijali sa tom oznakom, kao i set povezanih oznaka. Povezane oznake su one koje se često pojavljuju na istoj stranici.

Svojstva stranica

Na stranicu možete dodati još jedan zanimljiv makro za strukturiranje informacija — „Svojstva stranica“. U njega treba uneti tabelu sa dva kolone, prva će biti ključ, a druga — vrednost svojstva. Osim toga, makro se može sakriti sa stranice kako ne bi ometao čitanje sadržaja, ali stranica će i dalje biti označena potrebnim ključevima.

Obratite pažnju na ID — lako je postaviti da se različite grupe svojstava povežu sa različitim stranicama (ili čak različitim grupama svojstava na jednoj stranici).

Izvještaji

Preko oznaka se mogu prikupljati izveštaji. Na primer, makro „Izveštaj o sadržaju“ prikuplja sve stranice sa određenim skupom oznaka.

Ali zanimljiviji izveštaj je makro „Izveštaj po svojstvima stranice“. On takođe prikuplja sve stranice sa određenim skupom oznaka, ali ne samo da ispisuje njihov spisak, već sastavlja tabelu (shvatate vezu s početkom članka?), u kojoj su kolone ključevi svojstava stranice.

Tako dobijate okvirnu tabelu koja sadrži informacije iz različitih izvora. Lepo je što ima korisne funkcije: responzivni dizajn, sortiranje po bilo kojoj koloni. Takođe, ovu izveštajnu tabelu možete konfigurisati unutar makroa.

Prilikom konfigurisanja možete iz izveštaja ukloniti određene kolone, postaviti stanje po defaultu ili broj prikazanih unosa. Takođe možete postaviti ID svojstva stranice da biste videli samo potrebne informacije.

Na primjer, imate mnogo stranica zaposlenika, koje imaju set svojstava o osobi: kojeg je nivoa, gdje se nalazi, kada se pridružio timu itd. Ova svojstva su označena ID = employee_inf. I postoji drugi set svojstava na istoj stranici, koji sadrži informacije o osobi kao dijelu tima: koju ulogu osoba obavlja, u kojem se timu nalazi itd. Ova svojstva su označena ID = team_inf. Tada prilikom sastavljanja izveštaja možete izvući informacije prema samo jednom ID-u ili odmah prema oba — kako vam više odgovara.

Čar ovog pristupa je u tome što svaki može sastaviti informativnu tabelu koja mu je potrebna, koja neće ništa duplicirati i biće ažurirana kada se ažurira glavna stranica. Na primjer: timu vođa nije važno kada su njegovi developeri započeli rad, ali je važno koju ulogu svatko od njih obavlja u timu. Timski vođa će sastaviti izveštaj o timu. A računovođi nije bitno ko koju ulogu obavlja, već su mu važne pozicije — sastaviće izveštaj o pozicijama. Pri tome izvor informacija se neće duplicirati ili prenositi.

Završni proces

Upute

Dakle, možemo lepo strukturirati i efikasno agregirati informacije u Confluence na primjeru korišćenja makroa. Ali u idealnom slučaju, potrebno je učiniti da nove informacije odmah budu strukturirane i da se uključe u sve već korišćene mehanizme agregacije.

Tu će pomoći kombinacija makroa i šablona. Da biste naterali ljude da kreiraju nove stranice u potrebnom formatu, možete koristiti makro "Kreiraj iz šablona". On dodaje na stranicu dugme, pritiskom na koje se kreira nova stranica iz potrebnog šablona. Tako prisiljavate ljude da odmah rade u formatu koji vam je potreban.

U šablon iz kojeg dajete mogućnost kreiranja stranice, treba unapred dodati oznake, makro "Svojstva stranice" i tabelu potrebnih svojstava. Takođe preporučujem da dodate uputstva o tome kojim vrednostima treba popuniti stranicu, i vrednosti svojstava.

Tada će završni proces izgledati ovako:

Kreirate šablon za informacije određenog tipa.
U taj šablon dodajete oznake i svojstva stranice u makro.
Na bilo kojem prikladnom mjestu stvarate glavnu stranicu s gumbom, na koji se klikom stvara podstranica na osnovu predloška.
Pustite na glavnu stranicu korisnike koji mogu potencijalno generirati potrebne informacije (po potrebnom predlošku, pritiskom na gumb).
Prikupite izvještaj o svojstvima stranice putem oznaka koje ste naveli u predlošku.
Veselite se: imate sve potrebne informacije u prikladnom formatu.

Skriveni problemi

Kao inženjer kvalitete, mogu reći da ništa savršeno ne postoji u svijetu. Čak ni božanske tablice nisu savršene. I u navedenom procesu postoje skrivene zamke.

Ako odlučite promijeniti nazive ili sastav svojstava stranice, morat ćete ažurirati sve već stvorene objekte kako bi se njihovi podaci ispravno povukli u sažetak. To je žalosno, ali s druge strane, tjera vas da detaljno osmislite 'arhitekturu' vašeg skupa informacija, što je vrlo zanimljiv zadatak.
Morat ćete napisati pristojan broj uputa o tome kako ispunjavati informacijske tablice i koristiti oznake. Međutim, s druge strane, možete jednostavno podijeliti ovu temu sa svim potrebnim osobama.

Primjer pohrane neproizvodne dokumentacije

Kroz gore navedeni proces možete organizirati pohranu gotovo bilo koje informacije. Čar ovog pristupa je u tome što je univerzalan: kada se korisnici naviknu, prestaju generirati nered. Također, veliki (ali ne besplatan) plus — mogućnost prikupljanja raznolike statistike u hodu i izrade lijepih dijagrama na temelju nje.

Navest ću primjer našeg procesa vođenja informacija o timu.

Za svaku osobu u timu odlučili smo stvoriti karticu zaposlenika. Tako da imamo predložak, prema kojem svaka nova osoba stvara svoju karticu i vodi u njoj sve osobne informacije.

Kao što vidite, imamo razrađenu tablicu svojstava i odmah su dostupne upute o tome kako voditi ovu stranicu. Dio oznaka postavljaju sami zaposlenici prema uputama, u predlošku su samo osnovne: oznaka kartice employee-card, oznaka smjera direction-involve i oznaka tima team-qa.

Kao rezultat, nakon što svaki korisnik stvori svoj profil, dobija se potpuna tabela sa informacijama o zaposlenicima. Ove informacije mogu se koristiti na različitim mestima. Resursni menadžeri mogu sastaviti zajedničke tabele, a vođe timova tabele timova dodavajući oznaku tima u izbor.

Preko oznaka možete videti različite sažetke, na primer po qa-upgrade-plan će se prikazati svi zadaci za razvoj QA. Pri tome svaka osoba na svom profilu vodi važnu priču i svoj plan razvoja — stvara podstranicu prema šablonu razvojnih planova.