Pozdrav!
Moje ime je Masha, radim kao inženjer za osiguranje kvalitete u grupi tvrtki Tinkoff. QA posao uključuje puno komunikacije s različitim ljudima iz različitih timova, a bila sam i voditeljica i predavačica edukacijskih 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 popunjavati paklene tone nečitljivih tablica i dokumenata.
Sigurno je svatko od vas sada zamislio o čemu pričam i oblio ga hladan znoj: popisi prezimena bez abecednog reda, tablice sa stotinama stupaca neuredno postavljenih, tablice s tisućama redaka u kojima treba obrisati prst na kotačiću miša da biste pogledali naslov, tone stranica nenumeriranih uputa, stotine pisama poslanih jedni drugima s podacima koje treba analizirati i sistematizirati i strpati u iste nečitljive tablice.
I tako, kad sam se malo ohladio, odlučio sam napisati ovaj članak. Govorit ću o tome kako možete normalno (čak ponekad i zgodno) održavati raznovrsnu dokumentaciju koja nije povezana s proizvodom. Nadam se da će se članak raspršiti mrežom i da će razina pakla u odjelima uz razvoj barem malo pasti, a ljudi (uključujući i mene) postati malo sretniji.
Alat
Dokumentacija proizvoda često se čuva uz kod, što je dobra stvar. A dokumentacija koja nije vezana uz proizvod obično se pohranjuje bilo gdje. Ljudi često pokušavaju unijeti informacije s različitih mjesta u Confluence, a mi nismo iznimka. Dakle, ostatak priče je o njemu.
Općenito, Confluence je napredan wiki motor. Omogućuje vam rad s podacima u različitim vrstama prikaza: tekst s oblikovanjem, tablice, razni grafikoni. Ovo je vrlo zanimljiv i moćan alat, ali ako ne znate kako ga kuhati, dobit ćete još jednu hrpu nečitljivih dokumenata. Naučit ću te kuhati!
Makronaredbe
Gotovo sva magija Confluencea izgrađena je oko makroa. Ima puno makronaredbi i mogu se međusobno kombinirati. Oni se plaćaju i besplatni su, nadalje će biti raznih primjera makronaredbi s poveznicama na dokumentaciju za njih.
Sučelje za rad s makronaredbama je maksimalno jednostavno. Za dodavanje makronaredbe potrebno je kliknuti na plus i s popisa odabrati željeni element.
Ako je makronaredba samodostatna, odnosno ne zahtijeva umetanje nečeg drugog unutar sebe, izgleda kao blok.
Ako makrou treba nešto unutar njega da bi radio, izgleda kao kutija.
U isto vrijeme, možete staviti koliko god želite drugih unutar jednog okvira, sve dok postoji logika u vašoj piramidi.
Svaka makronaredba ima pregled: odmah pokazuje jeste li ispravno ispunili i konfigurirali makronaredbu.
Predlošci
Osim makronaredbi, postoji praktičan alat za prethodno popunjavanje sadržaja - ovo je predložak.
Predlošci se mogu koristiti pri izradi bilo koje stranice: samo kliknite na tri točkice pokraj gumba "Izradi" i odaberite željeni predložak.
Tada će sav sadržaj koji se nalazi u predlošku biti dodan na kreiranu stranicu.
Svatko može stvarati stranice iz predložaka, ali samo oni koji imaju prava sami stvarati ili uređivati predloške mogu stvarati stranice. U predložak možete dodati dodatne upute o tome kako se stranica treba održavati.
Stolna magija
Zapravo, kao tehničar, jako volim tablice i u njih mogu umotati gotovo sve informacije (iako to nije uvijek učinkovito). Same tablice su jasne, strukturirane, skalabilne, čarobne!
Ali čak i tako divan entitet kao što je stol može biti pokvaren. I može se uspješno koristiti i čak poboljšati. Više o tome u nastavku.
Filtriranje (plaćeni dodatak)
Bilo koja ogromna nečitljiva tablica može se učiniti malo manje ogromnom i malo čitljivijom pomoću filtriranja. Da biste to učinili, možete koristiti plaćeni makro .
Unutar ovog makronaredbe trebate ugurati stol (čak i najružniji je moguć, glavno je ugurati ga cijelog). U makronaredbi možete odabrati stupce za padajući filtar, filtar teksta, numerički filtar i filtar datuma.
Zamislite samo da su svi podaci o kandidatima za sva slobodna radna mjesta evidentirani u tabelarnom popisu. Naravno, nerazvrstano - ljudi ne dolaze na razgovore abecednim redom. I morate razumjeti jeste li prije intervjuirali određenog kandidata. Trebate samo staviti ovaj pakao u makronaredbu filtera, dodati filter teksta prema prezimenu - i voila, informacije su na vašem ekranu.
Vrijedno je napomenuti da filtriranje velikih tablica može utjecati na performanse sustava i vrijeme učitavanja stranice, stoga je stavljanje ogromne tablice u filtar privremena štaka, bolje je izgraditi proces u kojem ljudi ne moraju stvarati ogromne nečitljive tablice ( primjer procesa bit će na kraju članka).
Razvrstavanje (plaćeni dodatak)
Uz Magic Macro također možete postaviti zadano sortiranje na bilo kojem stupcu i numerirati retke. Ili kliknite na bilo koji stupac tablice stavljen u makronaredbu filtera i pojavit će se sortiranje po tom stupcu.
Na primjer, imate istu tablicu s kandidatima i morate izračunati koliko je razgovora održano u određenom mjesecu - sortirajte po datumu i radujte se.
Zaokretne tablice (dodatak koji se plaća)
Sada prijeđimo na zanimljiviji slučaj. Zamislite da je vaš stol ogroman i na njemu trebate nešto izračunati. Naravno, možete ga kopirati u Excel, izračunati što vam treba i učitati podatke natrag u Confluence. Možete li jednom primijeniti makro? i dobiti isti rezultat, samo ažuriran.
Na primjer: imate tablicu koja sadrži podatke o svim zaposlenicima – gdje se geografski nalaze i koje pozicije imaju. Da biste izračunali koliko je ljudi u svakom gradu, potrebno je u makrou "Pivot Table" odabrati red po kojem se podaci agregiraju (lokacija) i tip operacije (zbrajanje).
Naravno, možete grupirati prema nekoliko kriterija odjednom, možete vidjeti sve mogućnosti .
Grafikoni (plaćeni dodatak)
Kao što sam rekao, ne vole svi stolove kao ja. Nažalost, većina menadžera ih uopće ne voli. Ali svi vole jarke karte u boji.
Tvorci Confluencea su to sigurno znali (sigurno i oni imaju šefove koji vole izvješća i grafikone, gdje bi bez toga). Stoga možete koristiti magični makro . U ovu makronaredbu trebate staviti pivot tablicu iz prethodnog odlomka i voila - vaši dosadni sivi podaci su lijepo vizualizirani.
Naravno, ovaj makro također ima postavke. Poveznica na dokumentaciju za bilo koju makronaredbu može se pronaći u načinu uređivanja te makronaredbe.
Lakoća agregacije
Podaci iz prethodnih odlomaka vjerojatno vam nisu bili otkriće. Ali sada definitivno znate kako koristiti makronaredbe i mogu prijeći na zanimljiviji dio članka.
Tagovi
Loše je kada ljudi spremaju informacije u jedan nestrukturirani članak ili ogromnu tablicu. Još gore je kada su dijelovi tih informacija ne samo nečitljivi, nego su i razbacani po prostranstvima Confluencea. Srećom, moguće je prikupiti raštrkane informacije na jednom mjestu. Za ovo trebate koristiti (tagovi poznati svima na društvenim mrežama).
Bilo koji broj oznaka može se dodati na bilo koju stranicu. Klikom na oznaku odvest ćete se na agregacijsku stranicu s poveznicama na sav sadržaj s tom oznakom, kao i na skup povezanih oznaka. Povezane oznake su one koje se često pojavljuju na istoj stranici.
Svojstva stranice
Možete dodati još jednu zanimljivu makronaredbu na stranicu za strukturiranje informacija - . Unutar njega trebate podnijeti tablicu od dva stupca, prvi će biti ključ, a drugi vrijednost svojstva. Štoviše, makro se može sakriti sa stranice kako ne bi ometao čitanje sadržaja, ali će stranica i dalje biti označena potrebnim ključevima.
Obratite pozornost na ID - prikladno ga je postaviti da objesi različite grupe nekretnina na različite stranice (ili čak različite grupe nekretnina na jednoj stranici).
Izvješća
Po oznakama možete prikupljati izvješća. Na primjer, makro prikuplja sve stranice s određenim skupom oznaka.
Ali zanimljivije izvješće je makro . Također prikuplja sve stranice s određenim skupom oznaka, ali ih ne navodi samo, već sastavlja tablicu (hvatate li vezu s početkom članka?), u kojoj su stupci ključevi svojstava stranice.
Ispada sažetak tablice informacija iz različitih izvora. Lijepo je što ima prikladne značajke: prilagodljiv izgled, sortiranje po bilo kojem stupcu. Također, takva se tablica izvješća može konfigurirati unutar makronaredbe.
Prilikom konfiguracije možete ukloniti neke stupce iz izvješća, 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 puno stranica zaposlenika, te stranice imaju skup svojstava o osobi: koja je razina, gdje je, kada se pridružio timu i tako dalje. Ova svojstva su označena id = zaposlenik_inf. A postoji i drugi skup svojstava na istoj stranici, koji sadrži informacije o osobi kao dijelu tima: koju ulogu osoba ima, u kojem je timu i tako dalje. Ova svojstva su označena ID = team_inf. Zatim, prilikom sastavljanja izvješća, možete prikazati samo informacije za jedan ID ili dva odjednom - što god vam je zgodnije.
Ljepota ovog pristupa je u tome što svatko može prikupiti informacijsku tablicu koja mu je potrebna, koja neće ništa duplicirati i ažurirat će se kada se ažurira glavna stranica. Na primjer: voditelju tima nije bitno kada su njegovi programeri dobili posao, već je važno kakvu ulogu svaki od njih ima u timu. Voditelj tima će prikupiti izvješće o timu. I računovođu nije briga tko obavlja koju ulogu, ali bitne su pozicije - on će sakupiti izvješće o pozicijama. U tom slučaju, izvor informacija neće biti umnožen ili prenesen.
Završni proces
Nastava
Dakle, možemo lijepo strukturirati i učinkovito agregirati informacije u Confluence koristeći makronaredbe kao primjer. Ali u idealnom slučaju, trebate osigurati da se nove informacije odmah strukturiraju i uđu u sve mehanizme prikupljanja koji se već koriste.
Ovdje će hrpa makronaredbi i predložaka doći u pomoć. Kako biste naveli ljude da stvaraju nove stranice u pravom formatu, možete upotrijebiti makronaredbu Stvori iz predloška. Dodaje gumb na stranicu, klikom na koji se kreira nova stranica iz predloška koji vam je potreban. Na ovaj način tjerate ljude da odmah rade u formatu koji vam je potreban.
U predložak iz kojeg dopuštate izradu stranice potrebno je unaprijed dodati oznake, makro "Svojstva stranice" i tablicu svojstava koja su vam potrebna. Također preporučujem dodavanje uputa o tome kojim vrijednostima ispuniti stranicu i vrijednosti svojstava.
Tada će konačni proces izgledati ovako:
- Stvarate predložak za određenu vrstu informacija.
- U ovom predlošku dodajte oznake i svojstva stranice u makronaredbi.
- Na bilo kojem prikladnom mjestu stvorite korijensku stranicu s gumbom, klikom na koji se iz predloška stvara dječja stranica.
- Pokrenite se na root stranici korisnika koji će potencijalno generirati potrebne informacije (prema željenom predlošku, klikom na gumb).
- Prikupite sami izvješće o svojstvima stranice pomoću oznaka koje ste naveli u predlošku.
- Radujte se: imate sve informacije koje trebate u prikladnom formatu.
Zamke
Kao inženjer kvalitete, slobodno 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ć stvorene objekte tako da se njihovi podaci ispravno povuku u sažeto izvješće. 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 uputa o tome kako popuniti informacijske tablice 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 postupak možete organizirati pohranu gotovo svih informacija. Ljepota pristupa je u tome što je univerzalan: kada se korisnici naviknu na njega, prestaju raditi nered. Također veliki (ali ne i besplatan) plus je mogućnost prikupljanja raznih statistika u hodu i crtanja lijepih dijagrama na njemu.
Dat ću primjer našeg procesa održavanja informacija o timu.
Za svaku osobu u timu odlučili smo izraditi karticu zaposlenika. Sukladno tome, imamo predložak prema kojem svaka nova osoba za sebe kreira ovu karticu i u njoj čuva sve svoje osobne podatke.
Kao što vidite, imamo detaljnu tablicu svojstava i odmah imamo upute o tome kako održavati ovu stranicu. Neke oznake stavljaju sami zaposlenici prema uputama, u predlošku samo one glavne: oznaka kartice iskaznica zaposlenika, oznaka smjera smjer-uključiti i komandna oznaka tim-qa.
Kao rezultat toga, nakon što svatko izradi karticu za sebe, dobiva se cjelovita tablica s podacima o zaposlenicima. Ove informacije mogu se koristiti u različitim točkama. Upravitelji resursa mogu prikupljati općenite tablice za sebe, a voditelji timova mogu prikupljati naredbene tablice dodavanjem oznake tima odabiru.
Po oznakama možete vidjeti različite sažetke, na primjer, po qa-plan-nadogradnje bit će prikazani svi zadaci za QA razvoj. Istovremeno, svaka osoba u svojoj kartici zaposlenika čuva važnu priču i svoj plan razvoja - kreira ugniježđenu stranicu iz predloška planova razvoja.
Zaključak
Svaku dokumentaciju čuvajte na način da je se ne sramite, a korisnici ne budu nesnosno povrijeđeni!
Stvarno se nadam da će članak biti koristan i da će doći red u svu dokumentaciju svijeta.
Izvor: www.habr.com