Pozdrav svima!
Moje ime je Maša, radim kao inženjer za osiguranje kvaliteta u grupi kompanija Tinkoff. QA posao uključuje dosta komunikacije sa različitim ljudima iz različitih timova, a bio sam i menadžer i predavač edukativnih programa, tako da je moja komunikacijska mapa bila što šira. I u jednom trenutku sam eksplodirao: shvatio sam da više ne mogu, ne mogu, ne mogu da popunjavam paklene tone nečitljivih tabela i dokumenata.
Sigurno je svako od vas sada zamislio o čemu pričam i oblio se hladan znoj: spiskovi prezimena bez abecednog reda, tabele sa stotinama kolona neurednog rasporeda, tabele sa hiljadama redova u kojima treba da obrišete prst na kotačiću miša da pogledate naslov, tone stranica nenumeriranih uputstava, stotine pisama koje se međusobno šalju sa podacima koje treba analizirati i sistematizirati i strpati u iste nečitljive tabele.
I tako, kada sam se malo ohladio, odlučio sam da napišem ovaj članak. Govorit ću o tome kako možete normalno (čak ponekad i zgodno) održavati raznovrsnu dokumentaciju koja nije proizvod. Nadam se da će se članak raspršiti po mreži i da će nivo pakla u odjeljenjima uz razvoj barem malo pasti, a ljudi (uključujući i mene) postati malo sretniji.
Alati
Dokumentacija o proizvodu se često čuva uz kod, što je dobra stvar. A dokumentacija koja se ne odnosi na proizvod obično se pohranjuje bilo gdje. Ljudi često pokušavaju donijeti informacije sa različitih mjesta u Confluence, i mi nismo izuzetak. Dakle, ostatak priče je o njemu.
Općenito, Confluence je napredna wiki mašina. Omogućava vam rad sa podacima u različitim vrstama prikaza: tekst sa formatiranjem, tabele, razni grafikoni. Ovo je vrlo zanimljiv i moćan alat, ali ako ne znate kako ga skuhati, onda ćete dobiti još jednu deponiju nečitljivih dokumenata. Naučiću te kako da kuvaš!
Makroi
Gotovo sva magija Confluencea izgrađena je oko makroa. Postoji mnogo makroa i mogu se kombinovati jedni s drugima. Oni su plaćeni i besplatni, dalje će biti raznih primjera makroa sa linkovima na dokumentaciju za njih.
Interfejs za rad sa makroima je što jednostavniji. Da biste dodali makro, potrebno je kliknuti na plus i odabrati željeni element sa liste.
Ako je makro samodovoljan, odnosno ne zahtijeva umetanje nečeg drugog unutar sebe, izgleda kao blok.
Ako makrou treba nešto unutar njega da bi radio, on izgleda kao kutija.
Istovremeno, u jedan okvir možete staviti koliko god želite, sve dok u vašoj piramidi postoji logika.
Svaki makro ima pregled: odmah pokazuje da li ste ispravno popunili i konfigurisali makro.
Obrasci
Osim makronaredbi, postoji i zgodan alat za prethodno popunjavanje sadržaja - ovo je predložak.
Predlošci se mogu koristiti prilikom kreiranja bilo koje stranice: samo kliknite na tri tačke pored gumba "Kreiraj" i odaberite željeni predložak.
Tada će sav sadržaj koji se nalazi u predlošku biti dodan na kreiranu stranicu.
Svatko može kreirati stranice od šablona, ali samo oni koji imaju prava da sami kreiraju ili uređuju šablone mogu kreirati stranice. Možete dodati dodatne upute u predložak o tome kako stranicu treba održavati.
Table Magic
Zapravo, kao tehničar, jako volim tablice i mogu u njih umotati gotovo sve informacije (iako to nije uvijek efikasno). Same tabele su jasne, strukturirane, skalabilne, magične!
Ali čak i tako divan entitet kao što je sto može biti pokvaren. I može se uspješno koristiti, pa čak i poboljšati. Više o tome u nastavku.
Filtriranje (plaćeni dodatak)
Bilo koja ogromna nečitljiva tabela može se učiniti malo manje ogromnom i malo čitljivom pomoću filtriranja. Da biste to učinili, možete koristiti plaćeni makro .
Unutar ovog makroa morate ugurati sto (čak je i najružniji mogući, glavna stvar je da ga gurnete u potpunosti). U makronaredbi možete odabrati stupce za padajući filter, tekstualni filter, numerički i datumski filter.
Zamislite samo da se sve informacije o kandidatima za sva slobodna radna mjesta zapisuju u tabelarni spisak. Naravno, nerazvrstano - ljudi ne dolaze na intervju po abecednom redu. I morate razumjeti da li ste ranije intervjuirali određenog kandidata. Samo treba da stavite ovaj pakao u makro filtera, dodate filter teksta po prezimenu - i voila, informacije su na vašem ekranu.
Važno je napomenuti da filtriranje ogromnih tabela može uticati na performanse sistema i vreme učitavanja stranice, tako da je stavljanje ogromne tabele u filter privremena štaka, bolje je izgraditi proces u kojem ljudi ne moraju da kreiraju ogromne nečitljive tabele ( primjer procesa bit će na kraju članka).
Sortiranje (plaćeni dodatak)
Sa Magic Macro također možete postaviti zadano sortiranje na bilo koju kolonu i numerirati redove. Ili kliknite na bilo koju kolonu tabele stavljenu u makro filter i sortiranje po ovoj koloni će se desiti.
Na primjer, imate istu tabelu sa kandidatima i trebate izračunati koliko je intervjua održano u određenom mjesecu - sortirajte po datumu i radujte se.
Pivot Tables (plaćeni dodatak)
Sada pređimo na zanimljiviji slučaj. Zamislite da je vaš sto ogroman i na njemu morate nešto izračunati. Naravno, možete ga kopirati u Excel, izračunati šta vam treba i prenijeti podatke nazad u Confluence. Možete li jednom primijeniti makro? i dobiti isti rezultat, samo ažuriran.
Na primjer: imate tabelu koja sadrži podatke o svim zaposlenima - gdje se geografski nalaze i koje pozicije imaju. Da biste izračunali koliko ljudi ima u svakom gradu, potrebno je da u makro "Pivot Table" odaberete red po kojem se podaci agregiraju (lokacija) i vrstu operacije (dodavanje).
Naravno, možete grupisati po nekoliko kriterija odjednom, možete vidjeti sve mogućnosti .
Karte (plaćeni dodatak)
Kao što sam rekao, ne vole svi stolove kao ja. Nažalost, većina menadžera ih uopšte ne voli. Ali svi vole grafikone jarkih boja.
Kreatori Confluence-a su sigurno znali za ovo (sigurno imaju i šefove koji vole izvještaje i grafikone, gdje bi bez toga). Stoga možete koristiti magični makro . U ovu makronaredbu morate staviti stožernu tabelu iz prethodnog pasusa i voila - vaši dosadni sivi podaci su lijepo vizualizirani.
Naravno, ovaj makro takođe ima podešavanja. Veza do dokumentacije za bilo koji makro može se naći u modu za uređivanje tog makroa.
Jednostavnost agregacije
Informacija iz prethodnih pasusa za vas vjerovatno nije bila otkrovenje. Ali sada definitivno znate kako koristiti makroe, a ja mogu prijeći na zanimljiviji dio članka.
Oznake
Loše je kada ljudi spremaju informacije u jedan nestrukturirani članak ili ogromnu tabelu. Još gore je kada su dijelovi ovih informacija ne samo nečitljivi, već su i razbacani po prostranstvima Konfluencije. Srećom, moguće je prikupiti razbacane informacije na jednom mjestu. Za ovo morate koristiti (oznake svima poznate na društvenim mrežama).
Bilo koji broj oznaka može se dodati na bilo koju stranicu. Klikom na oznaku odvest će vas na stranicu agregacije sa vezama za sav sadržaj s tom oznakom, kao i skup povezanih oznaka. Povezane oznake su one koje se često pojavljuju na istoj stranici.
Svojstva stranice
Možete dodati još jedan zanimljiv makro na stranicu za strukturiranje informacija - . Unutar nje treba da pošaljete tabelu od dve kolone, prva će biti ključ, a druga vrednost svojstva. Štaviše, makro se može sakriti sa stranice tako da ne ometa čitanje sadržaja, ali će stranica i dalje biti označena potrebnim ključevima.
Obratite pažnju na ID - zgodno je postaviti ga da visi različite grupe svojstava na različitim stranicama (ili čak različite grupe svojstava na jednoj stranici).
Otčety
Po oznakama možete prikupljati izvještaje. Na primjer, makro prikuplja sve stranice sa određenim skupom oznaka.
Ali zanimljiviji izvještaj je makro . Takođe prikuplja sve stranice sa određenim skupom oznaka, ali ih ne samo navodi, već sastavlja tabelu (hvatate li vezu sa početkom članka?), u kojoj su kolone ključevi svojstava stranice.
Ispada zbirna tabela informacija iz različitih izvora. Lijepo je što ima zgodne karakteristike: prilagodljiv izgled, sortiranje po bilo kojoj koloni. Takođe, takva tabela za izveštavanje može se konfigurisati unutar makroa.
Prilikom konfigurisanja možete ukloniti neke kolone iz izvještaja, postaviti zadano stanje ili broj prikazanih zapisa. Također možete postaviti ID svojstva stranice da vidite samo informacije koje su vam potrebne.
Na primjer, imate mnogo stranica o zaposlenima, ove stranice imaju skup svojstava o osobi: na kojem je nivou, gdje se nalazi, kada se pridružio timu, itd. Ova svojstva su označena id = zaposlenik_inf. I postoji drugi skup svojstava na istoj stranici, koji sadrži informacije o osobi kao dijelu tima: koju ulogu osoba obavlja, u kojem je timu, itd. Ova svojstva su označena ID = team_inf. Zatim, prilikom sastavljanja izvještaja, možete prikazati samo informacije za jedan ili dva ID odjednom - što je zgodnije.
Ljepota ovog pristupa je u tome što svako može prikupiti informacijsku tabelu koja mu je potrebna, koja neće ništa duplicirati i bit će ažurirana kada se glavna stranica ažurira. Na primjer: vođi tima nije važno kada su njegovi programeri dobili posao, ali je važno koju ulogu svaki od njih ima u timu. Vođa tima će prikupiti izvještaj o timu. A računovođu nije briga ko koju ulogu obavlja, ali pozicije su važne - on će prikupiti izvještaj o pozicijama. U ovom slučaju, izvor informacija se neće umnožavati ili prenositi.
Završni proces
Upute
Dakle, možemo lijepo strukturirati i efikasno agregirati informacije u Confluence koristeći makroe kao primjer. Ali idealno bi bilo da se pobrinete da nove informacije budu odmah strukturirane i da uđu u sve mehanizme agregacije koji se već koriste.
Ovdje će gomila makroa i šablona doći u pomoć. Da biste naveli ljude da kreiraju nove stranice u pravom formatu, možete koristiti makro Kreiraj iz predloška. Dodaje dugme na stranicu, klikom na koje se kreira nova stranica od šablona koji vam je potreban. Na taj način natjerate ljude da odmah rade u formatu koji vam je potreban.
U predložak iz kojeg dopuštate kreiranje stranice potrebno je da dodate oznake, makro "Svojstva stranice" i tabelu sa svojstvima koja su vam potrebna unaprijed. Također preporučujem dodavanje instrukcija o tome kojim vrijednostima treba popuniti stranicu i vrijednostima svojstava.
Tada će konačni proces izgledati ovako:
- Kreirate predložak za određenu vrstu informacija.
- U ovom predlošku dodajte oznake i svojstva stranice u makronaredbu.
- Na bilo kojem prikladnom mjestu kreirajte korijensku stranicu s gumbom, klikom na koju se kreira podređena stranica iz predloška.
- Pokrenite na root stranici korisnika koji će potencijalno generirati potrebne informacije (prema željenom šablonu, klikom na dugme).
- Prikupite sami izvještaj o svojstvima stranice putem oznaka koje ste naveli u predlošku.
- Radujte se: imate sve informacije koje su vam potrebne u prikladnom formatu.
zamke
Kao inženjer kvaliteta, sa sigurnošću mogu reći da na svijetu ne postoji ništa savršeno. Čak su i božanski stolovi nesavršeni. I postoje zamke u gore navedenom procesu.
- Ako odlučite promijeniti nazive ili sastav svojstava stranice, morat ćete ažurirati sve već kreirane objekte kako bi se njihovi podaci ispravno povukli u sažeti izvještaj. To je tužno, ali s druge strane, tjera vas da detaljno razmislite o "arhitekturi" vašeg skupa informacija, što je vrlo zanimljiv zadatak.
- Morat ćete napisati pristojnu količinu instrukcija o tome kako popuniti tablice s informacijama i koristiti oznake. Ali, s druge strane, možete jednostavno baciti ovaj članak svim pravim ljudima.
Primjer pohranjivanja dokumentacije koja nije proizvod
Kroz gore opisani proces možete organizirati pohranu gotovo svih informacija. Ljepota pristupa je u tome što je univerzalan: kada se korisnici naviknu, prestaju praviti nered. Također veliki (ali ne i besplatan) plus je mogućnost prikupljanja raznih statistika u hodu i crtanja prekrasnih dijagrama na njima.
Navest ću primjer našeg procesa održavanja informacija o timu.
Za svaku osobu u timu odlučili smo da napravimo karticu zaposlenika. Shodno tome, imamo šablon prema kojem svaka nova osoba kreira ovu karticu za sebe i u njoj čuva sve svoje lične podatke.
Kao što vidite, imamo detaljnu tabelu svojstava i odmah imamo uputstva kako da održavamo ovu stranicu. Neke od oznaka zaposleni stavljaju sami prema uputstvu, u šablonu samo glavne: oznaka kartice kartica zaposlenika, oznaka smjera smjer-uključiti i komandna oznaka team-qa.
Kao rezultat, nakon što svako kreira karticu za sebe, dobija se kompletna tabela sa podacima o zaposlenima. Ove informacije se mogu koristiti na različitim mjestima. Menadžeri resursa mogu prikupljati opšte tabele za sebe, a vođe tima mogu prikupljati komandne tabele dodavanjem oznake tima izboru.
Po oznakama možete vidjeti različite sažetke, na primjer, po qa-upgrade-plan bit će prikazani svi zadaci za razvoj QA. Istovremeno, svaka osoba u svojoj radnoj kartici čuva važnu priču i svoj razvojni plan - kreira ugniježđenu stranicu od predloška razvojnih planova.
zaključak
Svaku dokumentaciju čuvajte na način da je se ne sramite, a da korisnici ne budu strašno povrijeđeni!
Zaista se nadam da će članak biti koristan i da će doći red u svu dokumentaciju svijeta.
izvor: www.habr.com