Pozdravljeni vsi!
Moje ime je Masha, delam kot inženir za zagotavljanje kakovosti v skupini podjetij Tinkoff. QA delo vključuje veliko komunikacije z različnimi ljudmi iz različnih timov, bil pa sem tudi vodja in predavatelj izobraževalnih programov, tako da je bil moj komunikacijski zemljevid kar se da širok. In v nekem trenutku sem eksplodiral: ugotovil sem, da ne morem, ne morem, ne morem izpolniti peklenske tone neberljivih tabel in dokumentov.
Zagotovo si je vsak od vas zdaj predstavljal, o čem govorim, in ga oblil hladen znoj: seznami priimkov brez abecede, tabele s stotinami stolpcev z ukrivljeno postavitvijo, tabele s tisočimi vrsticami, v katere je treba obrisati prst. na kolescu miške, da pogledam glavo, na tone strani neoštevilčenih navodil, na stotine pisem, poslanih drug drugemu s podatki, ki jih je treba analizirati in sistematizirati ter stlačiti v enako neberljive tabele.
In tako, ko sem se malo ohladil, sem se odločil napisati ta članek. Govoril bom o tem, kako lahko običajno (tudi včasih priročno) vzdržujete različno dokumentacijo, ki ni povezana z izdelki. Upam, da se bo članek razširil po internetu in se bo stopnja pekla v oddelkih, ki mejijo na razvoj, vsaj malo zmanjšala, ljudje (vključno z mano) pa bodo postali malo srečnejši.
Orodja
Dokumentacija o izdelku je pogosto shranjena poleg kode, kar je dobro. In dokumentacija, ki ni izdelek, je običajno shranjena kjer koli. Ljudje pogosto poskušajo premakniti informacije z različnih krajev v Confluence in mi nismo izjema. Preostanek zgodbe je torej o njem.
Na splošno je Confluence napreden wiki motor. Omogoča vam delo s podatki v različnih vrstah prikaza: besedilo z oblikovanjem, tabele, različni grafikoni. To je zelo zanimivo in zmogljivo orodje, a če ne veste, kako ga pripraviti, boste na koncu dobili še eno smetišče neberljivih dokumentov. Naučil te bom kuhati!
Makri
Skoraj vsa čarovnija Confluence izvira iz makrov. Makrojev je veliko in jih je mogoče kombinirati med seboj. Lahko so plačljivi ali brezplačni; spodaj bodo različni primeri makrov s povezavami do dokumentacije zanje.
Vmesnik za delo z makri je čim bolj preprost. Če želite dodati makro, morate klikniti na plus in s seznama izbrati želeni element.
Če je makro samostojen, to pomeni, da ne zahteva vstavljanja ničesar drugega vase, je videti kot blok.
Če makro zahteva, da je nekaj vstavljeno vanj, da deluje, je videti kot okvir.
Hkrati pa lahko v en okvir postavite poljubno število drugih, če le obstaja logika v vaši piramidi.
Vsak makro ima predogled: takoj pokaže, ali ste makro pravilno izpolnili in konfigurirali.
Predloge
Poleg makrov je na voljo priročno orodje za predhodno polnjenje vsebine - predloga.
Predloge lahko uporabite pri ustvarjanju katere koli strani: kliknite na tri pike poleg gumba »Ustvari« in izberite želeno predlogo.
Nato bo vsa vsebina, ki je v predlogi, dodana na ustvarjeno stran.
Vsakdo lahko ustvari strani iz predlog, vendar lahko to storijo le tisti, ki imajo pravice za ustvarjanje ali urejanje predlog sami. V predlogo lahko dodate dodatna navodila o vzdrževanju strani.
Čarobnost miz
Pravzaprav imam kot tehnik zelo rad tabele in lahko vanje zavijem skoraj vse informacije (čeprav to ni vedno učinkovito). Same tabele so pregledne, strukturirane, razširljive, čarobne!
Toda tudi tako čudovita entiteta, kot je miza, se lahko uniči. In lahko ga uspešno uporabljate in celo izboljšate. Več o tem spodaj.
Filtriranje (plačljiv vtičnik)
Vsako ogromno, neberljivo tabelo je mogoče s filtriranjem narediti malo manj ogromno in malo bolj berljivo. Za to lahko uporabite plačan makro .
V ta makro morate postaviti tabelo (tudi najgrša je možna, glavna stvar je, da jo potisnete v celoti). V makru lahko izberete stolpce za spustni filter, besedilni filter, številski filter in datumski filter.
Samo predstavljajte si, da so vsi podatki o kandidatih za vsa prosta delovna mesta zabeleženi v tabelarnem seznamu. Seveda nerazvrščeno - ljudje prihajajo na razgovore ne po abecednem vrstnem redu. In razumeti morate, ali ste že opravili razgovor z določenim prosilcem. Samo vstaviti morate ta pekel v makro filtra, dodati besedilni filter po priimku - in voila, informacije so na vašem zaslonu.
Omeniti velja, da lahko filtriranje ogromnih tabel vpliva na zmogljivost sistema in čas nalaganja strani, zato je vstavljanje ogromne tabele v filter začasna opora; bolje je zgraditi proces, v katerem ljudem ni treba ustvarjati ogromnih, neberljivih tabel (an primer postopka bo na koncu članka).
Razvrščanje (plačljiv vtičnik)
Uporaba čarobnega makra Prav tako lahko nastavite privzeto razvrščanje za kateri koli stolpec in oštevilčite vrstice. Ali kliknite kateri koli stolpec tabele, ki je vstavljen v makro filtra, in razvrstitev bo izvedena po tem stolpcu.
Na primer, imate isto tabelo s prosilci in morate oceniti, koliko razgovorov je bilo opravljenih v določenem mesecu - razvrstite po datumu in bodite srečni.
Vrtilne tabele (plačljiv vtičnik)
Zdaj pa preidimo na bolj zanimiv primer. Predstavljajte si, da je vaša tabela ogromna in morate iz nje nekaj izračunati. Seveda ga lahko kopirate v Excel, izračunate, kar potrebujete, in naložite podatke nazaj v Confluence. Ali lahko enkrat uporabite makro? in dobite enak rezultat, le posodobljen.
Na primer: imate tabelo, ki zbira podatke o vseh zaposlenih – kje se geografsko nahajajo in na katerih položajih. Če želite izračunati, koliko ljudi je v posameznem mestu, morate v makru vrtilne tabele izbrati vrstico, ki združuje podatke (lokacija) in vrsto operacije (dodajanje).
Seveda lahko združujete po več kriterijih hkrati, vse možnosti si lahko ogledate .
Grafikoni (plačljiv vtičnik)
Kot sem rekel, nimajo vsi tako radi miz kot jaz. Žal jih večina menedžerjev sploh ne mara. Toda vsi imajo radi živobarvne diagrame.
Ustvarjalci Confluence so zagotovo vedeli za to (verjetno imajo tudi oni šefe, ki obožujejo poročila in diagrame, kje bi brez tega). Zato lahko uporabite čarobni makro . V ta makro morate postaviti vrtilno tabelo iz prejšnjega odstavka in voila - vaši sivi dolgočasni podatki so lepo vizualizirani.
Seveda ima ta makro tudi nastavitve. Povezavo do dokumentacije za kateri koli makro lahko najdete v načinu urejanja tega makra.
Enostavno združevanje
Podatki iz prejšnjih odstavkov za vas verjetno niso bili razodetje. Zdaj pa zagotovo veste, kako uporabljati makre, in lahko preidem na bolj zanimiv del članka.
oznake
Slabo je, če ljudje hranijo informacije v enem nestrukturiranem članku ali ogromni tabeli. Še huje je, če so deli teh informacij ne le neberljivo oblikovani, ampak tudi raztreseni po Confluenceu. Na srečo je mogoče na enem mestu zbrati razpršene informacije. Če želite to narediti, morate uporabiti (oznake, znane vsem iz družbenih omrežij).
Na katero koli stran lahko dodate poljubno število oznak. S klikom na oznako boste preusmerjeni na stran z združevanjem s povezavami do vse vsebine s to oznako, kot tudi niz povezanih oznak. Sorodne oznake so tiste, ki se pogosto pojavljajo na isti strani.
Lastnosti strani
Na stran lahko dodate še en zanimiv makro za strukturiranje informacij - . Znotraj nje morate predložiti tabelo dveh stolpcev, prvi bo ključ, drugi pa vrednost lastnosti. Poleg tega lahko makro skrijete s strani, tako da ne moti branja vsebine, vendar bo stran še vedno označena s potrebnimi ključi.
Bodite pozorni na ID - priročno ga je nastaviti tako, da različnim stranem dodeli različne skupine lastnosti (ali celo različne skupine lastnosti eni strani).
poročila
Poročila lahko zbirate z oznakami. Na primer, makro zbira vse strani z določenim nizom oznak.
Toda bolj zanimivo poročilo je makro . Zbere tudi vse strani z določenim naborom oznak, vendar ne prikaže le seznama le-teh, temveč ustvari tabelo (ujamete povezavo z začetkom članka?), v kateri so stolpci strani lastninski ključi.
Rezultat je zbirna tabela informacij iz različnih virov. Lepo je, da ima priročne funkcije: prilagodljiva postavitev, razvrščanje po katerem koli stolpcu. Takšno tabelo poročanja je mogoče konfigurirati tudi znotraj makra.
Pri konfiguraciji lahko odstranite nekatere stolpce iz poročila, nastavite privzeto stanje ali število prikazanih zapisov. Nastavite lahko tudi ID lastnosti strani, da vidite samo informacije, ki jih potrebujete.
Na primer, imate veliko strani zaposlenih, te strani imajo nabor lastnosti o osebi: na kateri ravni je, kje je, kdaj se je pridružila ekipi itd. Te lastnosti so označene ID = zaposleni_inf. Na isti strani je še drugi niz lastnosti, ki vsebuje informacije o osebi kot delu ekipe: kakšno vlogo ima oseba, v kateri ekipi je itd. Te lastnosti so označene ID = team_inf. Nato lahko pri sestavljanju poročila prikažete samo informacije za en ID ali dva hkrati - kar je bolj priročno.
Lepota tega pristopa je v tem, da lahko vsak sestavi tabelo s podatki, ki jo potrebuje, ki ne bo ničesar podvajala in bo posodobljena, ko bo posodobljena glavna stran. Na primer: vodji ekipe ni pomembno, kdaj so njegovi razvijalci dobili službo, pomembno pa je, kakšno vlogo ima vsak od njih v ekipi. Vodja ekipe bo zbral poročilo o ekipi. In računovodji je na splošno vseeno, kdo opravlja kakšno vlogo, pomembni pa so položaji - o položajih bo sestavil poročilo. V tem primeru vir informacij ne bo podvojen ali prenesen.
Končni postopek
Navodila
Tako lahko lepo strukturiramo in učinkovito združujemo informacije v Confluence z uporabo makrov kot primera. V idealnem primeru pa morate poskrbeti, da so nove informacije takoj strukturirane in vključene v vse mehanizme združevanja, ki so že v uporabi.
Tu bo na pomoč priskočila kopica makrov in predlog. Če želite ljudi prisiliti, da ustvarijo nove strani v želenem formatu, lahko uporabite makro Ustvari iz predloge. Na stran doda gumb, ko ga kliknete, se ustvari nova stran iz predloge, ki jo potrebujete. Na ta način prisilite ljudi, da takoj delajo v formatu, ki ga potrebujete.
V predlogo, iz katere ustvarite stran, morate vnaprej dodati oznake, makro »Lastnosti strani« in tabelo lastnosti, ki jih potrebujete. Priporočam tudi, da dodate navodila o tem, katere vrednosti je treba izpolniti na strani in vrednosti lastnosti.
Nato bo končni postopek izgledal takole:
- Ustvarite predlogo za določeno vrsto informacij.
- V tej predlogi dodate oznake in lastnosti strani v makro.
- Na katerem koli priročnem mestu ustvarite korensko stran z gumbom, s klikom na katerega ustvarite podrejeno stran iz predloge.
- Uporabnikom omogočite, da gredo na korensko stran, ki bo potencialno ustvarila potrebne informacije (v skladu z zahtevano predlogo, s klikom na gumb).
- Zberete poročilo o lastnostih strani z uporabo oznak, ki ste jih podali v predlogi.
- Veselite se: imate vse potrebne informacije v priročni obliki.
Pasti
Kot inženir kakovosti lahko mirno trdim, da nič na svetu ni popolno. Tudi božanske mize so nepopolne. In v zgornjem postopku obstajajo pasti.
- Če se odločite spremeniti imena ali sestavo lastnosti strani, boste morali posodobiti vse že ustvarjene objekte, da bodo njihovi podatki pravilno vključeni v zbirno poročilo. To je žalostno, a po drugi strani vas prisili, da podrobno razmislite o »arhitekturi« svojega niza informacij, kar je zelo zanimiva naloga.
- Morali boste napisati precej navodil o tem, kako izpolniti informacijske tabele in uporabljati oznake. Po drugi strani pa lahko s tem člankom preprosto zadenete vse prave ljudi.
Primer shranjevanja dokumentacije, ki ni povezana z izdelkom
Z zgoraj opisanim postopkom lahko organizirate shranjevanje skoraj vseh informacij. Lepota pristopa je v tem, da je univerzalen: ko se uporabniki navadijo nanj, prenehajo ustvarjati nered. Še en velik (vendar ne zastonj) plus je možnost sprotnega zbiranja različnih statističnih podatkov in risanja lepih diagramov na njihovi podlagi.
Naj vam dam primer našega postopka za vzdrževanje informacij o ekipi.
Odločili smo se, da izdelamo kartico zaposlenega za vsako osebo v timu. V skladu s tem imamo predlogo, po kateri vsaka nova oseba zase ustvari to kartico in v njej hrani vse osebne podatke.
Kot lahko vidite, imamo podrobno tabelo lastnosti in takoj navodila, kako natančno vzdrževati to stran. Nekatere oznake dodajajo zaposleni sami po navodilih, predloga vsebuje le glavne: oznaka kartice izkaznica zaposlenega, smerna oznaka smer-vključevati in oznaka ekipe team-qa.
Kot rezultat, potem ko je vsak ustvaril kartico zase, dobimo popolno tabelo s podatki o zaposlenih. Te informacije je mogoče uporabiti na različnih točkah. Upravitelji virov lahko sami zbirajo splošne tabele, vodje skupin pa lahko ustvarijo timske tabele tako, da izboru dodajo oznako ekipe.
Ogledate si lahko na primer različne povzetke po oznakah načrt-nadgradnje qa Prikazane bodo vse naloge razvoja QA. Hkrati vsaka oseba hrani pomembno zgodovino in lasten razvojni načrt v svoji kartici zaposlenega – ustvari ugnezdeno stran iz predloge razvojnih načrtov.
Zaključek
Vsakršno dokumentacijo vzdržujte tako, da je ni sramota in uporabnikom ne povzroča neznosnih bolečin!
Resnično upam, da bo članek koristen in bo prišel red v vso dokumentacijo na svetu.
Vir: www.habr.com