Zdravo svima!
Moje ime je Maša, delam kot inženirka kakovosti v skupini podjetij Tinkoff. Delo v QA vključuje številne komunikacije z različnimi ljudmi iz različnih ekip, poleg tega pa sem bila tudi vodja in predavateljica izobraževalnih programov, zato je bila moja komunikacijska mreža izjemno široka. In v nekem trenutku sem popustila: spoznala sem, da ne morem več, ne morem, ne morem izpolnjevati neprestanih ton neberljivih tabel in dokumentov.
Verjetno si je vsak izmed vas sedaj predstavljal, o čem govorim, in se oblil s hladnim znojem: seznami priimkov brez abecednega reda, tabele s stotimi stolpci z zmešano postavitvijo, tabele z na stotine vrsticami, kjer je treba s prstom drgniti po koleščku miške, da bi videli naslov, tone nepodštevilčenih navodil, stotine e-pošt, ki si jih med seboj pošiljamo z podatki, ki jih je treba analizirati in sistematizirati ter stisniti v prav tako neberljive tabele.
In tako, ko sem se nekoliko umirila, sem se odločila napisati ta članek. Povedala bom, kako lahko normalno (včasih celo udobno) vodimo raznoliko neraziskovalno dokumentacijo. Upam, da bo članek zaokrožil po spletu in da se bo nivo nerazumljivosti v sosednjih oddelkih za razvoj vsaj malo zmanjšal, ljudje (in tudi jaz) pa postali srečnejši.
Orodja
Dokumentacija o izdelku se pogosto hrani skupaj s kodo, kar je dobro. Neraziskovalna dokumentacija pa se običajno hrani kjerkoli. Ljudje pogosto poskušajo prenesti informacije z različnih mest v Confluence, in mi nismo izjema. Torej, vse nadaljnje pripovedovanje o tem.
Confluence je v bistvu napreden wiki-motor. Omogoča delo z informacijami v različnih oblikah prikaza: besedilo s formatiranjem, tabele, različne diagrame. To je zelo zanimivo in močno orodje, vendar, če ga ne znate pripraviti, boste dobili le še eno zmešnjavo neberljivih dokumentov. Naučil vas bom, kako ga pripraviti!
Makroji
Skoraj vsa magija Confluence temelji na makrojih. Makrojev je veliko, in jih je mogoče kombinirati med seboj. Obstajajo plačljivi in brezplačni makroji, spodaj bodo različni primeri makrojev s povezavami na dokumentacijo zanje.
Vmesnik za delo z makroji je izjemno preprost. Da dodate makro, morate pritisniti na plus in izbrati ustrezen element s seznama.
Če je makro samostojen, torej ne zahteva vstavljanja ničesar drugega v sebe, izgleda kot blok.
Če makro za delovanje potrebuje, da vanj nekaj postavite, izgleda kot okvir.
Vanjo lahko vstavite poljubno število drugih okvirjev, če je v vaši piramidi logika.
Vsak makro ima predogled: takoj je vidno, ali ste pravilno izpolnili in nastavili makro.
Predloge
Poleg makrov je udoben orodje za predpolnitev vsebine — to je predloga.
Predloge lahko uporabite pri ustvarjanju katere koli strani: preprosto kliknite na tri pike poleg gumba »Ustvari« in izberite želeno predlogo.
Takrat se bo v ustvarjeno stran dodala vsa vsebina, ki jo vsebuje predloga.
Strani iz predlog lahko ustvarja kdorkoli, medtem ko lahko same predloge ustvarjajo ali urejajo le tisti, ki imajo za to pravice. V predlogo lahko dodate dodatna navodila o tem, kako naj se stran vodi.
Magija tabel
V resnici, kot tehnik, nežno ljubim tabele in lahko skoraj vsako informacijo zavijem vanje (čeprav to ni vedno učinkovito). Same tabele so jasne, strukturirane, razširljive, čarobne!
Toda tudi tako čudovito entiteto, kot je tabela, lahko pokvarite. Lahko pa jo uspešno uporabite in celo izboljšate. O tem spodaj.
Filtriranje (plačljiv dodatek)
Vsako ogromno neurejeno tabelo lahko naredite nekoliko manj ogromno in nekoliko bolj berljivo s pomočjo filtriranja. Za to lahko uporabite plačljiv makro .
V ta makro morate vstaviti tabelo (lahko celo najbolj grdo, glavna stvar je, da jo vstavite celotno). V makru lahko izberete stolpce za filtriranje iz spustnega menija, besedilnega filtra, številčnega in filtra po datumih.
Predstavljajte si, da so vse informacije o kandidatih za vse razpise zapisane v tabeli. Seveda niso razvrščene — ljudje na razgovore ne prihajajo po abecedi. In vi morate razumeti, ali ste že intervjuvali določenega kandidata. Preprosto vstavite to zmešnjavo v makro za filtriranje, dodajte besedilni filter po priimku — in voila, informacije so na vašem zaslonu.
Pomembno je omeniti, da lahko filtriranje velikih tabel vpliva na delovanje sistema in čas nalaganja strani, zato je umestitev velike tabele v filtriranje le začasna rešitev; bolje je vzpostaviti proces, pri katerem ljudje ne bodo morali ustvarjati ogromnih, neberljivih tabel (primer procesa bo na koncu članka).
Razvrščanje (plačljiv vtičnik)
Z magičnim makrom lahko prav tako nastavite privzeto razvrščanje po katerem koli stolpcu in oštevilčite vrstice. Ali pa kliknete na kateri koli stolpec tabele, vdelane v makro filtriranja, in razvrstitev se izvede po tem stolpcu.
Na primer, imate isto tabelo s kandidati in želite oceniti, kolikšno število intervjujev je bilo izvedenih v določenem mesecu — razvrstite po datumu in uživajte.
Pivotske tabele (plačljiv vtičnik)
Sedaj preidimo na zanimivejši primer. Predstavljajte si, da je vaša tabela ogromna in morate nekaj izračunati na njej. Seveda jo lahko kopirate v Excel, izračunate potrebno in podatke znova prenesete v Confluence. Lahko pa enkrat uporabite makro in dobite enak rezultat, ki se še posodablja.
Na primer: imate tabelo, v kateri so zbrani podatki vseh zaposlenih — kje se geografsko nahajajo in katere položaje zasedajo. Da bi izračunali, koliko ljudi je v vsakem mestu, morate v makru „Pivotska tabela“ izbrati vrstico, po kateri se agregirajo podatki (lokacija) in tip operacije (seštevanje).
Seveda lahko grupirate tudi po več znakih hkrati, vse možnosti si lahko ogledate .
Diagrama (plačljiv vtičnik)
Kot sem že omenila, ne marajo vsi tabel tako zelo kot jaz. Na žalost jih večina managerjev sploh ne ljubi. Zato pa vsi zelo radi imajo svetle barvne diagrame.
Ustvarjalci Confluence so o tem zagotovo vedeli (verjetno imajo tudi sami nadrejene, ki ljubijo poročila in diagrame, kamor pa brez njih). Zato lahko uporabite čarobni makro . V ta makro morate vstaviti pivotsko tabelo iz prejšnje točke, in voila — vaši sivi, dolgočasni podatki so lepo vizualizirani.
Seveda ima tudi ta makro nastavitve. Povezavo na dokumentacijo za kateri koli makro lahko najdete v načinu urejanja tega makra.
Enostavnost agregacije
Informacije iz prethodnih tačaka sigurno vam nisu bile otkrovenje. Ali sada sigurno znate kako koristiti makroe, a mogu preći na zanimljiviji deo članka.
Oznake
Loše je kada ljudi čuvaju informacije u jednoj nestrukturiranoj članku ili ogromnoj tabeli. Još gore — kada su delovi tih informacija ne samo nečitko oblikovani, već su i raspršeni po Confluence-u. Srećom, postoji mogućnost okupljanja raspršenih informacija na jednom mestu. Da biste to uradili, treba da iskoristite (poznate svima po društvenim mrežama).
Na svaku stranicu možete dodati bilo koji broj tagova. Ako kliknete na tag, bićete preusmereni na stranicu agregacije, gde su linkovi na sve materijale sa tim tagom, kao i vezani tagovi. Vezani tagovi su oni koji se često pojavljuju na istoj stranici.
Svojstva stranica
Na stranicu možete dodati još jedan zanimljiv makro za strukturiranje informacija — . Unutra treba uneti tabelu od dva kolone, pri čemu će prva biti ključ, a druga — vrednost svojstva. Makro se može sakriti sa stranice, kako ne bi ometao čitanje sadržaja, ali će strana i dalje biti označena potrebnim ključevima.
Obratite pažnju na ID — lako je podesiti da se dodele različite grupe svojstava različitim stranicama (ili čak različitim grupama svojstava na jednoj stranici).
Izveštaji
Po tagovima možete sakupljati izveštaje. Na primer, makro sakuplja sve stranice sa određenim skupom tagova.
Ali zanimljiviji izveštaj je makro . Takođe sakuplja sve stranice sa određenim skupom tagova, ali ne jednostavno ispisuje njihov spisak, već sastavlja tabelu (primetili ste povezanost s početkom članka?), u kojoj su kolone — ključevi svojstava stranice.
Dobija se pregledna tabela o informacijama iz različitih izvora. Prijatan je dodatak što ima praktične funkcije: responzivni raspored, sortiranje po bilo kojoj koloni. Takođe, takvu izveštajnu tabelu možete konfigurisati unutar makroa.
Tokom konfiguracije možete ukloniti određene kolone iz izveštaja, postaviti podrazumevano stanje ili broj prikazanih zapisa. A takođe možete postaviti ID svojstva stranice kako biste videli samo potrebne informacije.
Na primer, imate mnogo stranica zaposlenih, a svaka od tih stranica ima set osobina koje se odnose na osobu: koja je njegova pozicija, gde se nalazi, kada je došao u tim i tako dalje. Ove osobine su označene ID = employee_inf. I postoji drugi set osobina na istoj stranici, koji sadrži informacije o osobi, kao delu tima: koju ulogu osoba obavlja, u kojem timu se nalazi i tako dalje. Ove osobine su označene ID = team_inf. Tada prilikom sastavljanja izveštaja možete prikazati informacije samo po jednom ID-ju ili odmah po oba — kako vam više odgovara.
Veza takvog pristupa je u tome što svako može da sastavi informativnu tabelu koja mu je potrebna, koja neće ništa duplirati i biće ažurirana kada se glavna stranica ažurira. Na primer: tim lideru nije važno kada su njegovi programeri zaposleni, ali je važno koju ulogu svako od njih obavlja u timu. Tim lider će sastaviti izveštaj za tim. A knjigovođi je potpuno svejedno ko koju ulogu obavlja, ali su mu važna radna mesta — on će sastaviti izveštaj prema radnim mestima. Pri tome, izvor informacija se neće duplirati ili premeštati.
Konačni proces
Navodilo
Dakle, možemo lepo strukturirati i efikasno agregirati informacije u Confluence-u na primeru korišćenja makroa. Ali u idealnom slučaju treba da se postigne da nove informacije odmah budu strukturirane i ulaze u sve već korišćene mehanizme agregacije.
Tu će vam pomoći kombinacija makroa i šablona. Da biste podstakli ljude da kreiraju nove stranice u potrebnom formatu, možete koristiti makro "Kreirati iz šablona". On dodaje dugme na stranicu, a pritiskom na njega kreira se nova stranica iz potrebnog šablona. Tako naterate ljude da odmah rade u formatu koji vam je potreban.
U šablon iz kojeg omogućavate kreiranje stranice, unapred treba dodati oznake, makro "Svojstva stranice" i tabelu potrebnih svojstava. Takođe preporučujem da dodate uputstva o tome kojima vrednostima treba popuniti stranicu i vrednosti svojstava.
Tada će konačni proces izgledati ovako:
- Kreirate šablon za informacije određenog tipa.
- U ovaj šablon dodajete oznake i svojstva stranice u makrou.
- Na katerem koli priročnem mestu ustvarite glavno stran s gumbom, s katerim se ob kliku ustvari podstran iz predloge.
- Na glavno stran spustite uporabnike, ki bodo potencialno generirali potrebne informacije (po ustrezni predlogi, s klikom na gumb).
- Zberite poročilo o lastnostih strani prek oznak, ki ste jih navedli v predlogi.
- Veselite se: imate vse potrebne informacije v priročni obliki.
Skrbi
Kot inženir kakovosti lahko brez zadržkov trdim, da na svetu ni nič idealnega. Tudi božanske tabele niso brez napak. V opisanem procesu so tudi pasti.
- Če se odločite spremeniti imena ali sestavo lastnosti strani, boste morali posodobiti vse že ustvarjene objekte, da se njihovi podatki pravilno prenesejo v skupno poročilo. To je žalostno, vendar pa vas hkrati spodbuja, da podrobno razmislite o 'arhitekturi' vašega nabora informacij, kar je zelo zanimiva naloga.
- Moral boste napisati precej navodil o tem, kako izpolnjevati informacijske tabele in uporabljati oznake. Po drugi strani pa lahko preprosto pošljete to besedilo vsem potrebnim osebam.
Primer shranjevanja nespecifične dokumentacije
S pomočjo opisanega procesa lahko organizirate shranjevanje skoraj vsake informacije. Lepota pristopa je v njegovi univerzalnosti: ko se uporabniki nanj navadijo, prenehajo ustvarjati zmedo. Tudi veliki (vendar ne brezplačni) plus je možnost zbiranja raznolike statistike v realnem času in ustvarjanja lepih diagramov na njeni podlagi.
Prikazal bom primer našega procesa vodenja informacij o ekipi.
Za vsakega člana ekipe smo se odločili ustvariti kartico zaposlenega. Tako imamo predlogo, po kateri vsak nov član ustvari svojo kartico in vanjo vodi vse osebne informacije.
Kot vidite, imamo razširjen tabelar oblik lastnosti in že so na voljo navodila o tem, kako voditi to stran. Dela oznak postavljajo sami zaposleni po navodilih, v predlogi so le osnovne: oznaka kartice employee-card, oznaka smeri direction-involve in oznaka ekipe team-qa.
Na koncu, ko si vsak ustvari svojo kartico, dobimo popolno tabelo z informacijami o zaposlenih. Te informacije je mogoče uporabiti na različnih mestih. Vodje virov lahko sestavijo skupne tabele, vodje ekip pa tabele ekip, tako da dodajo oznako ekipe v izbor.
Po oznakah je mogoče videti različne povzetke, na primer za qa-upgrade-plan se bodo prikazale vse naloge za razvoj QA. Hkrati vsaka oseba v svoji kartici zaposlenega vodi pomembno zgodbo in svoj razvojni načrt – ustvari podstran iz predloge razvojnih načrtov.
Zaključek
Vodenje katere koli dokumentacije tako, da ni treba sramovati, in da uporabnikom ni mučno!
Upam, da bo članek koristen in da bo v vsem dokumentaciji po svetu prišlo do reda.
Izvor: habr.com
