Tere kõigile!
Minu nimi on Masha, töötan Tinkoffi ettevõtete grupis kvaliteedi tagamise insenerina. QA töö hõlmab palju suhtlemist erinevate inimestega erinevatest meeskondadest ning olin ka haridusprogrammide juht ja lektor, seega oli minu suhtluskaart võimalikult lai. Ja mingil hetkel ma plahvatasin: mõistsin, et ma ei suuda enam, ma ei saa, ma ei suuda täita paganama tonni loetamatuid tabeleid ja dokumente.
Kindlasti kujutas igaüks teist nüüd ette, millest ma räägin, ja jooksis külma higi: perekonnanimede loendid ilma tähestikulise järjekorrata, sadade veergudega tabelid lohaka paigutusega, tuhandete ridadega tabelid, millelt peate sõrme kustutama. hiireratta peal pealkirja vaatamiseks, tonnide viisi lehekülgi nummerdamata juhiseid, sadu üksteisele saadetud kirju andmetega, mida on vaja analüüsida ja süstematiseerida ning toppida samadesse loetamatutesse tabelitesse.
Ja kui ma veidi maha jahtusin, otsustasin selle artikli kirjutada. Ma räägin sellest, kuidas saate tavaliselt (isegi mõnikord mugavalt) hooldada mitmesuguseid tooteväliseid dokumente. Loodan, et artikkel hajub üle võrgu ja põrgu tase arendusega külgnevates osakondades vähemalt veidi langeb ning inimesed (sealhulgas ka mina) muutuvad veidi õnnelikumaks.
Töövahendid
Tootedokumentatsiooni hoitakse sageli koos koodiga, mis on hea. Ja tootega mitteseotud dokumentatsiooni säilitatakse tavaliselt kõikjal. Tihti püüavad inimesed Confluence’i tuua infot erinevatest kohtadest ja meie pole erand. Nii et ülejäänud lugu räägib temast.
Üldiselt on Confluence täiustatud vikimootor. See võimaldab teil töötada andmetega erinevat tüüpi kuvades: vorminguga tekst, tabelid, erinevad diagrammid. See on väga huvitav ja võimas tööriist, kuid kui te ei tea, kuidas seda valmistada, saate järjekordse loetamatute dokumentide prügimäe. Ma õpetan sulle süüa tegema!
Makrod
Peaaegu kogu Confluence'i võlu on üles ehitatud makrode ümber. Makrosid on palju ja neid saab omavahel kombineerida. Need on tasulised ja tasuta, edaspidi on mitmesuguseid makrode näiteid koos linkidega nende jaoks mõeldud dokumentatsioonile.
Makrodega töötamise liides on võimalikult lihtne. Makro lisamiseks peate klõpsama plussil ja valima loendist soovitud elemendi.
Kui makro on isemajandav, see tähendab, et see ei nõua enda sisse millegi muu sisestamist, näeb see välja nagu plokk.
Kui makro vajab töötamiseks midagi selle sees, näeb see välja nagu kast.
Samas võid ühe raami sisse panna nii palju teisi, kui sulle meeldib, kui sinu püramiidis on loogikat.
Igal makrol on eelvaade: see näitab kohe, kas olete makro õigesti täitnud ja seadistanud.
Mallid
Lisaks makrodele on olemas mugav tööriist sisu eeltäitmiseks – see on mall.
Malle saab kasutada mis tahes lehe loomisel: klõpsake lihtsalt nupu "Loo" kõrval olevat kolme punkti ja valige soovitud mall.
Seejärel lisatakse loodud lehele kogu mallis olev sisu.
Mallide põhjal saab lehti luua igaüks, kuid lehti saavad luua ainult need, kellel on õigus malle ise luua või redigeerida. Saate mallile lisada täiendavaid juhiseid selle kohta, kuidas lehte tuleks hooldada.
Lauamaagia
Tegelikult armastan ma tehnikainimesena tabeleid ja suudan neisse mässida peaaegu igasuguse teabe (kuigi see pole alati tõhus). Tabelid ise on selged, struktureeritud, skaleeritavad, maagilised!
Kuid isegi sellist imelist olendit nagu laud võib rikkuda. Ja seda saab edukalt kasutada ja isegi täiustada. Sellest lähemalt allpool.
Filtreerimine (tasuline pistikprogramm)
Iga suurt loetamatut tabelit saab filtreerimise abil muuta veidi vähem suureks ja veidi loetavamaks. Selleks saate kasutada tasulist makrot .
Selle makro sees peate lükkama laua (ka kõige inetum on võimalik, peaasi, et see täielikult lükatakse). Makros saate valida veerge rippmenüüfiltri, tekstifiltri, numbri- ja kuupäevafiltri jaoks.
Kujutage vaid ette, et kogu teave kõigi vabade ametikohtade kandidaatide kohta on salvestatud tabeliloendisse. Loomulikult sorteerimata – inimesed ei tule intervjuudele tähestikulises järjekorras. Ja peate aru saama, kas olete konkreetse taotlejaga varem intervjueerinud. Peate lihtsalt panema selle põrgu filtrimakrosse, lisama tekstifiltri perekonnanime järgi – ja voila, teave on teie ekraanil.
Väärib märkimist, et tohutute tabelite filtreerimine võib mõjutada süsteemi jõudlust ja lehe laadimisaega, nii et suure tabeli filtrisse panemine on ajutine abinõu, parem on luua protsess, mille käigus inimesed ei peaks looma suuri loetamatuid tabeleid ( protsessi näide on artikli lõpus).
Sortimine (tasuline pistikprogramm)
Magic Macroga Samuti saate määrata mis tahes veeru vaikimisi sortimise ja nummerdada ridu. Või klõpsake filtri makrosse pandud tabeli mis tahes veergu ja sorteeritakse selle veeru järgi.
Näiteks on teil taotlejatega sama tabel ja peate välja selgitama, kui palju intervjuusid teatud kuul peeti – sortige kuupäeva järgi ja rõõmustage.
Pivot Tables (tasuline pistikprogramm)
Liigume nüüd huvitavama juhtumi juurde. Kujutage ette, et teie tabel on tohutu ja peate selle põhjal midagi arvutama. Loomulikult saate selle kopeerida Excelisse, arvutada, mida vajate, ja laadida andmed Confluence'i tagasi. Kas saate makrot ühe korra rakendada? ja saate sama tulemuse, ainult värskendatuna.
Näiteks: teil on tabel, mis sisaldab kõigi töötajate andmeid – kus nad geograafiliselt asuvad ja mis ametikohtadel nad on. Et arvutada, kui palju inimesi igas linnas on, tuleb makros "Pivot Table" valida rida, mille järgi andmed koondatakse (asukoht) ja toimingu tüüp (lisa).
Loomulikult saab grupeerida mitme kriteeriumi järgi korraga, näed kõiki võimalusi .
Diagrammid (tasuline pistikprogramm)
Nagu ma ütlesin, ei armasta kõik lauad nii palju kui mina. Kahjuks ei meeldi need enamusele juhtidele üldse. Kuid kõik armastavad eredaid värvitabeleid.
Confluence'i loojad kindlasti teadsid seda (kindlasti on neil ka ülemusi, kes armastavad aruandeid ja graafikuid, kus nad ilma selleta oleks). Seetõttu võite kasutada maagilist makrot . Sellesse makrosse peate panema eelmise lõigu pivot-tabeli ja voilaa - teie igavad hallid andmed on kaunilt visualiseeritud.
Loomulikult on sellel makrol ka sätted. Iga makro dokumentatsiooni lingi leiate selle makro redigeerimisrežiimist.
Lihtsus koondada
Eelmiste lõikude teave ei olnud teie jaoks ilmselt ilmutus. Kuid nüüd teate kindlasti, kuidas makrosid kasutada, ja ma saan liikuda artikli huvitavama osa juurde.
Sildid
See on halb, kui inimesed salvestavad teavet ühte struktureerimata artiklisse või tohutusse tabelisse. Veelgi hullem on see, kui osa sellest teabest pole mitte ainult loetamatud, vaid on ka Confluence'i avarustes laiali. Õnneks on võimalik hajali infot koguda ühte kohta. Selleks peate kasutama (sotsiaalvõrgustikes kõigile tuttavad sildid).
Igale lehele saab lisada suvalise arvu silte. Märgendil klõpsamine viib teid koondamislehele, millel on lingid kogu selle märgendiga sisule ja ka seotud siltide komplekt. Seotud sildid on need, mis ilmuvad sageli samal lehel.
Lehe atribuudid
Saate lisada lehele veel ühe huvitava makro teabe struktureerimiseks - . Selle sees peate esitama kahe veeru tabeli, millest esimene on võti ja teine vara väärtus. Veelgi enam, makro saab lehe eest ära peita, et see sisu lugemist ei segaks, kuid leht jääb ikkagi vajalike klahvidega märgistatud.
Pöörake tähelepanu ID-le – seda on mugav seadistada nii, et see riputaks erinevatele lehtedele erinevaid atribuutide gruppe (või isegi erinevaid atribuutide rühmi ühele lehele).
Teated
Siltide abil saate aruandeid koguda. Näiteks makro kogub kõik kindlate siltide komplektiga lehed.
Kuid huvitavam aruanne on makro . Samuti kogub see kokku kõik teatud siltide komplektiga lehed, kuid mitte lihtsalt ei loetle neid, vaid koostab tabeli (kas tabate seost artikli algusega?), milles veerud on lehe omaduste võtmed.
Selgub erinevatest allikatest pärit teabe kokkuvõtlik tabel. Tore, et sellel on mugavad funktsioonid: adaptiivne paigutus, sorteerimine mis tahes veeru järgi. Samuti saab sellist aruandlustabelit konfigureerida makro sees.
Seadistamisel saate aruandest eemaldada mõned veerud, määrata vaikeoleku või kuvatavate kirjete arvu. Samuti saate määrata lehe atribuudi ID, et näha ainult vajalikku teavet.
Näiteks on teil palju töötajate lehti, nendel lehtedel on inimese kohta atribuudid: mis tasemel ta on, kus ta on, millal ta meeskonnaga liitus jne. Need omadused on märgitud id = töötaja_teave. Ja samal lehel on ka teine atribuutide komplekt, mis sisaldab teavet inimese kui meeskonna osana: millist rolli inimene täidab, millises meeskonnas ta on jne. Need omadused on märgitud ID = meeskonna_info. Seejärel saab aruannet koostades korraga kuvada ainult ühe või kahe ID infot – kumb on mugavam.
Selle lähenemisviisi ilu seisneb selles, et igaüks saab koguda endale vajaliku teabetabeli, mis ei dubleeri midagi ja mida uuendatakse avalehe uuendamisel. Näiteks: meeskonnajuht ei hooli sellest, millal tema arendajad tööle said, vaid oluline on, millist rolli igaüks neist meeskonnas mängib. Meeskonna juht koostab meeskonna kohta aruande. Ja raamatupidajal pole vahet, kes millist rolli täidab, vaid ametikohad on olulised - ta kogub ametikohtade kohta aruande. Sel juhul teabeallikat ei dubleerita ega edastata.
Lõplik protsess
Juhendamine
Seega saame Confluence'is teavet kaunilt struktureerida ja tõhusalt koondada, kasutades näitena makrosid. Kuid ideaaljuhul peate veenduma, et uus teave on kohe struktureeritud ja satuks kõikidesse juba kasutusel olevatesse koondamismehhanismidesse.
Siin tuleb appi hunnik makrosid ja malle. Selleks, et inimesed saaksid luua õiges vormingus uusi lehti, saate kasutada makrot Loo mallist. See lisab lehele nupu, millele klõpsates luuakse Teile vajalikust mallist uus leht. Nii paned inimesed kohe vajalikus formaadis tööle.
Malli, millest lubate lehte luua, tuleb eelnevalt lisada sildid, makro "Lehe atribuudid" ja vajalike omaduste tabel. Soovitan lisada ka juhised selle kohta, milliste väärtustega leht täita ja atribuutide väärtused.
Seejärel näeb viimane protsess välja selline:
- Loote malli teatud tüüpi teabe jaoks.
- Selles mallis lisage makro sildid ja lehe atribuudid.
- Igas mugavas kohas loo nupuga juurleht, millele klõpsates luuakse mallist alamleht.
- Käivitage kasutajate juurlehel, kes potentsiaalselt genereerivad vajaliku teabe (vastavalt soovitud mallile, klõpsates nuppu).
- Koostage mallis määratud siltide kaudu lehe omaduste kohta aruanne.
- Rõõmustage: teil on kogu vajalik teave mugavas vormingus.
Lõksud
Kvaliteediinsenerina võin julgelt öelda, et maailmas pole midagi täiuslikku. Isegi jumalikud lauad on ebatäiuslikud. Ja ülaltoodud protsessis on lõkse.
- Kui otsustate muuta lehe atribuutide nimesid või koostist, peate värskendama kõiki juba loodud objekte, et nende andmed koondaruandesse õigesti tõmmata. See on kurb, kuid teisest küljest sunnib teid üksikasjalikult mõtlema oma teabekogumi "arhitektuuri" üle, mis on väga huvitav ülesanne.
- Peate kirjutama korraliku hulga juhiseid teabetabelite täitmise ja siltide kasutamise kohta. Kuid teisest küljest võite selle artikli lihtsalt õigetele inimestele visata.
Näide tootega mitteseotud dokumentatsiooni säilitamisest
Eespool kirjeldatud protsessi abil saate korraldada peaaegu igasuguse teabe salvestamise. Selle lähenemisviisi ilu seisneb selles, et see on universaalne: kui kasutajad sellega harjuvad, lõpetavad nad segaduse tegemise. Suureks (kuid mitte tasuta) plussiks on ka võimalus koguda käigu pealt erinevat statistikat ja joonistada sellele ilusaid diagramme.
Toon näite meie meeskonna kohta teabe säilitamise protsessist.
Iga meeskonnaliikme jaoks otsustasime luua töötaja kaardi. Vastavalt sellele on meil mall, mille järgi iga uus inimene loob endale selle kaardi ja hoiab selles kogu oma isikuandmeid.
Nagu näete, on meil üksikasjalik atribuutide tabel ja kohe juhised selle lehe hooldamiseks. Osa silte panevad töötajad ise vastavalt juhistele alla, mallis ainult peamised: kaardisilt töötaja kaart, suunasilt suund-kaasata ja käsusildi meeskond-qa.
Selle tulemusena saadakse pärast seda, kui igaüks on endale kaardi loonud, täielik tabel töötajate teabega. Seda teavet saab kasutada erinevates kohtades. Ressursihaldurid saavad koguda enda jaoks üldtabeleid ja meeskonnaliigid saavad koguda käsutabeleid, lisades valikule meeskonnasildi.
Siltide järgi näete erinevaid kokkuvõtteid, näiteks järgi qa-uuenduse plaan kuvatakse kõik QA arendamise ülesanded. Samas hoiab iga inimene oma töötaja kaardil olulist lugu ja oma arengukava - ta loob arengukavade mallist pesastatud lehe.
Järeldus
Hoidke dokumente nii, et te ei häbeneks seda ja kasutajad ei saaks piinavalt haiget!
Loodan väga, et artikkel on kasulik ja kogu maailma dokumentatsioon saab korda.
Allikas: www.habr.com