Pozdrav svima!
Zovem se Maša, radim kao inženjer kvalitete u grupi kompanija Tinkoff. QA posao podrazumijeva mnoge komunikacije s različitim ljudima iz različitih timova, a uz to sam bila menadžer i predavač obrazovnih programa, tako da je moja komunikacijska mapa bila maksimalno široka. I u nekom trenutku sam eksplodirala: shvatila sam da više ne mogu, ne mogu, ne mogu popunjavati strašne tone nečitljivih tabela i dokumenata.

Sigurno se svaki od vas sada zamislio u onome o čemu govorim i obliva hladan znoj: liste prezimena bez abecednog reda, tabele sa stotinama kolona sa pomjerenim formatom, tabele od hiljada redova u kojima morate pomjerati prst po točkiću miša da biste pogledali naslov, tone stranica nenumerisanih uputstava, stotine međusobno proslijeđenih e-mailova s podacima koje treba analizirati i sistematizovati i ugurati u iste te nečitljive tabele.

I tako, kada sam se malo smirila, odlučila sam napisati ovaj članak. Pričaću o tome kako se može normalno (čak i povremeno udobno) voditi raznolika neproizvodna dokumentacija. Nadam se da će članak proći mrežom i da će nivo haosa u susjednim odjelima sa razvojem bar malo opasti, a ljudi (uključujući mene) postati malo sretniji.

Brze postavke
Proizvodna dokumentacija često se čuva uz kod, i to je dobro. A neproizvodna dokumentacija obično se čuva gdje god. Često ljudi pokušavaju prenijeti informacije iz raznih mjesta u Confluence, a mi nismo izuzetak. Tako da će cijela dalja priča biti o tome.
U principu, Confluence je napredni wiki motor. Omogućava rad s podacima u različitim oblicima prikazivanja: formatirani tekst, tabele, razne dijagrame. To je vrlo zanimljiv i moćan alat, ali ako ne znate kako ga pripremiti, dobićete samo još jedan smeće nečitljivih dokumenata. Naučiću vas kako ga pripremiti!

Makarosi
Gotovo sva magija Confluence-a temelji se na makroima. Ima ih jako puno, i mogu se kombinirati jedni s drugima. Postoje plaćeni i besplatni, a u nastavku će biti različiti primjeri makroa s linkovima na dokumentaciju za njih.
Interfejs za rad s makroima je maksimalno jednostavan. Da biste dodali makro, potrebno je pritisnuti plus i izabrati željeni element s liste.

Ako je makro samoodrživ, što znači da ne zahteva umetanje nečega unutar sebe, izgleda kao blok.

Ako makro zahteva nešto da se umetne unutar njega, on izgleda kao okvir.

Možete umetnuti koliko god želite drugih elemenata unutar jednog okvira, sve dok vaša piramida ima logiku.

Svaki makro ima pregled: odmah možete videti da li ste pravilno popunili i podesili makro.
Šabloni
Pored makroa, postoji i praktičan alat za unapred pripremljen sadržaj — to su šabloni.
Šablone možete koristiti prilikom kreiranja bilo koje stranice: jednostavno kliknite na tri tačkice pored dugmeta „Kreirati“ i izaberite odgovarajući šablon.

U tom slučaju, na kreiranu stranicu će biti dodat sav sadržaj koji se nalazi u šablonu.
Svako može da kreira stranice iz šablona, dok samo oni koji imaju prava mogu da kreiraju ili uređuju same šablone. U šablon možete dodati dodatne instrukcije o tome kako treba voditi stranicu.

Magija tabela
U suštini, kao tehničar, duboko volim tabele i mogu skoro svaku informaciju da obavijem u njih (iako to ne mora uvek biti efikasno). Sve tabele su jasne, strukturirane, skalabilne, čarobne!

Ali čak i tako divnu stvar kao što je tabela, može se pokvariti. A može se i uspešno koristiti i čak poboljšati. O tome u nastavku.
Filtracija (plaćeni dodatak)
Svaku ogromnu, teško čitljivu tabelu možete učiniti malo manje ogromnom i malo čitljivijom pomoću filtracije. Za ovo se može koristiti plaćeni makro .
U ovaj makro treba umetnuti tabelu (možete čak i najružniju, glavno je da je ubacite celu). U makrou možete izabrati kolone za filtriranje iz padajućeg meni, tekstualne filtere, numeričke i filtere po datumima.

Zamislite da se sve informacije o kandidatima za sve pozicije beleže u tabelarnom formatu. Naravno, neuređeno — ljudi dolaze na intervjue ne abecednim redom. A vi treba da shvatite da li ste ranije obavili intervju sa određenim kandidatima. Samo treba da ubacite taj haos u makro filtra, dodate tekstualni filter po prezimenu — i voila, informacije su na ekranu.

Vredno je napomenuti da filtracija velikih tabela može uticati na rad sistema i vreme učitavanja stranica, zato ubacivanje velike tabele u filtriranje predstavlja privremeno rešenje; bolje je postaviti proces u kojem ljudima ne bi bilo potrebno da kreiraju ogromne nečitljive tabele (primer procesa biće na kraju članka).
Sortiranje (plaćeni dodatak)
Pomoću čarobnog makroa takođe možete postaviti podrazumevano sortiranje po bilo kojoj koloni i numerisati redove. Ili jednostavno kliknite na bilo koju kolonu tabele koja je ubačena u makro filtriranja i dobićete sortiranje po toj koloni.

Na primer, imate istu tabelu sa kandidatima i treba da procenite koliko je razgovora za posao obavljeno u određenom mesecu — sortirajte po datumu i uživajte.
Pivot tabele (plaćeni dodatak)
Sada prelazimo na zanimljiviji slučaj. Zamislite da je vaša tabela ogromna i da treba nešto da izračunate. Naravno, možete je kopirati u Excel, izračunati potrebne podatke i eksportovati ih nazad u Confluence. Ili možete jednom primeniti makro i dobiti isti rezultat, ali još i ažuriran.
Na primer: imate tabelu koja sadrži podatke svih zaposlenih — gde se nalaze i koje pozicije zauzimaju. Da biste izračunali koliko ljudi se nalazi u svakom gradu, potrebno je da u makro „Pivot tabela“ izaberete red po kojem se agregiraju podaci (lokacija) i tip operacije (sabiranje).

Naravno, možete grupisati prema više kriterijuma odjednom; sve mogućnosti možete pogledati .
Dijagrami (plaćeni dodatak)
Kao što sam već rekla, ne vole svi tabele jednako kao ja. Nažalost, menadžeri ih većinom uopšte ne vole. Ali svi jako vole živopisne šarene dijagrame.
Kreatori Confluence-a su o tome, bez sumnje, znali (sigurno imaju i oni nadredjene koji vole izveštaje i dijagrame, kuda bez toga). Zato možete iskoristiti čarobni makro . U ovaj makro treba ubaciti pivot tabelu iz prethodnog tačke, i vualá — vaši sivi dosadni podaci su lepo vizualizovani.

Naravno, ovaj makro takođe ima postavke. Link ka dokumentaciji za bilo koji makro možete pronaći u režimu uređivanja tog makroa.
Jednostavnost agregacije
Informacije iz prethodnih tačaka verovatno 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 jednoj neorganizovanoj članku ili ogromnoj tabeli. Još gore je kada su delovi tih informacija neuredno predstavljeni i raspršeni po Confluence-u. Na sreću, postoji mogućnost da se raspršene informacije okupe na jednom mestu. Da biste to uradili, trebate iskoristiti (poznate svima iz društvenih mreža).

Na svaku stranicu možete dodati neograničen broj oznaka. Ako pritisnete na oznaku, doći ćete na stranicu agregacije koja sadrži linkove na sve materijale sa tom oznakom, kao i na 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 strukturisanje informacija — . Unutar njega treba predstaviti tabelu sa dva kolone, pri čemu će prva 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 ga je dodeliti kako bi se različite grupe svojstava pridružile različitim stranicama (ili čak različitim grupama svojstava na jednoj stranici).
Izvještaji
Na osnovu oznaka možete sastavljati izveštaje. Na primer, makro sakuplja sve stranice sa određenim skupom oznaka.

Ali zanimljiviji izveštaj je makro . Takođe sakuplja sve stranice sa određenim skupom oznaka, ali ne samo ispisuje listu, već sastavlja tabelu (shvatate vezu sa početkom članka?), u kojoj su kolone — to su ključevi svojstava stranice.

Tako dobijate pivot tabelu informacija iz različitih izvora. Drago mi je što ima zgodne funkcije: responzivno formatiranje, sortiranje po bilo kojoj koloni. Takođe, ovu izveštajnu tabelu možete konfigurisati unutar makroa.

Prilikom konfiguracije možete ukloniti neke kolone iz izveštaja, postaviti stanje po defaultu ili broj prikazanih unosa. Takođe možete postaviti ID svojstva stranice, kako biste videli samo potrebne informacije.
Na primjer, imate mnoštvo stranica sa zaposlenicima, a te stranice imaju set svojstava o osobi: kojeg je nivoa, gdje se nalazi, kada se pridružila timu, i tako dalje. Ova svojstva su označena ID = employee_inf. A postoji i drugi set svojstava na istoj stranici, koji sakuplja informacije o osobi kao dijelu tima: koju ulogu osoba obavlja, u kojem timu se nalazi i tako dalje. Ova svojstva su označena ID = team_inf. Tada prilikom sastavljanja izvještaja možete izvući informacije po jednom ID-u ili odmah po oba — kako vam najbolje odgovara.
Prednost ovog pristupa je u tome što svako može sastaviti potrebnu informativnu tabelu koja neće ništa duplicirati i biće ažurirana kada se glavna stranica ažurira. Na primjer, vođi tima nije važno kada su njegovi programeri došli na posao, ali je važno koju ulogu svaki od njih obavlja u timu. Vođa tima će sastaviti izvještaj o timu. A knjigovođi je potpuno svejedno ko koju ulogu obavlja, ali su mu važne pozicije — on će sastaviti izvještaj o pozicijama. Pri tome izvor informacija se neće duplicirati ili premještati.
Završni proces
Uputstvo
Dakle, možemo lijepo strukturirati i efikasno agregirati informacije u Confluence koristeći primjere korištenja makroa. Ali idealno bi trebalo učiniti tako da nove informacije odmah budu strukturirane i ulaze u sve već korištene mehanizme agregacije.
Ovde će pomoći kombinacija makroa i šablona. Da biste natjerali ljude da kreiraju nove stranice u potrebnom formatu, možete koristiti makro „Kreiraj iz šablona“. On dodaje dugme na stranicu, na koje, kada se pritisne, kreira nova stranica iz željenog šablona. Na taj način natjeravate ljude da odmah rade u formatu koji vam je potreban.

U šablon iz kojeg dajete da se kreira stranica, potrebno je unaprijed dodati oznake, makro „Svojstva stranice“ i tabelu potrebnih svojstava. Također preporučujem da dodate upute o tome kakvim vrijednostima treba popuniti stranicu i vrijednosti svojstava.

Tada će završni proces izgledati ovako:
- Kreirate šablon za informacije određene vrste.
- U ovaj šablon dodajete oznake i svojstva stranice u makro.
- Na bilo kojem prikladnom mjestu kreirate matičnu stranicu s dugmetom, na koje se klikom stvara podstranica iz šablona.
- Propuštate korisnike na matičnu stranicu koji potencijalno mogu generisati potrebne informacije (prema potrebnom šablonu, klikom na dugme).
- Skupljate izvještaj prema svojstvima stranice putem oznaka koje ste naveli u šablonu.
- Veselite se: imate sve potrebne informacije u prikladnom formatu.

Zamke
Kao inženjer kvaliteta, slobodno mogu reći da ništa savršeno ne postoji u svijetu. Čak ni božanske tabele nisu savršene. I u ovom procesu postoje zamke.
- Ako odlučite promijeniti nazive ili sastav svojstava stranice, moraćete da ažurirate sve već stvorene objekte kako bi se njihovi podaci ispravno prenijeli u sveobuhvatni izvještaj. To je žalosno, ali, s druge strane, primorava vas da detaljno razmislite o "arhitekturi" vašeg skupa informacija, što je prilično zanimljiv zadatak.
- Moraćete napisati pristojan broj uputstava o tome kako popunjavati informacione tabele i koristiti oznake. No, s druge strane, možete jednostavno poslati svim potrebnim ljudima ovaj članak.
Primjer čuvanja neproizvodne dokumentacije
Kroz gorenavedeni proces može se organizovati čuvanje gotovo bilo kojih informacija. Čar ovog pristupa je u tome što je univerzalan: kada se korisnici naviknu na njega, prestaju generisati nered. Takođe, veliki (ali ne besplatan) plus je mogućnost prikupljanja raznolike statistike u letu i prikazivanje lijepih dijagrama.
Navedem primjer našeg procesa vođenja informacija o timu.

Za svaku osobu u timu odlučili smo stvoriti karticu zaposlenika. Tako da imamo šablon prema kojem svaka nova osoba pravi svoju karticu i vodi u njoj sve lične informacije.

Kao što vidite, imamo proširenu tabelu svojstava i odmah postoje uputstva o tome kako konkretno voditi ovu stranicu. Djelovi oznaka postavljaju sami zaposleni prema uputstvima, u šablonu su samo osnovne: oznaka kartice employee-card, oznaka pravca direction-involve i oznaka tima team-qa.
Kao rezultat, nakon što svaka osoba napravi svoj profil, dobijamo puni tabelu s informacijama o zaposlenicima. Ove informacije se mogu koristiti u različitim tačkama. Resursni menadžeri mogu da naprave zajedničke tabele, a lideri timova — timske tabele, dodajući u selekciju oznaku tima.
Preko oznaka se mogu videti različiti izvještaji, na primer, o qa-upgrade-plan prikazaće se svi zadaci za razvoj QA. Pri tome, svaka osoba u svom profilu vodi važnu priču i svoj plan razvoja — kreira podstranicu iz šablona planova razvoja.

Zaključak
Vodite svu dokumentaciju tako da ne bude sramota, a korisnicima ne bude mučno!
Nadam se da će članak biti koristan i da će u svim dokumentacijama sveta zavladati red.

Izvor: habr.com
