🥇Projekteerimine Confluence'is

Tere kõigile!

Minu nimi on Masha, olen kvaliteedi kindlustamise insener Tinkoffi kontsernis. QA töö hõlmab palju suhtlemist erinevate inimestega erinevates meeskondades, lisaks olen olnud juht ja koolitaja haridusprogrammides, seega oli mu suhtlemiskaart äärmiselt lai. Ja mingil hetkel plahvatasin: sain aru, et ma ei suuda enam, ei suuda enam, ei suuda enam täita kohutavaid tonne lugematud tabeleid ja dokumente.

Tõenäoliselt kujutas igaühe teist praegu ette, millest ma räägin, ja tõmbus külmavärin üle selja: nimede loendid, mis pole tähestikulises järjekorras, tabelid sadade veergudega, mille vormistus on paigast ära, tabelid tuhandete ridadega, kus tuleb sõrme hiiremati ratta vastu hõõruda, et näha pealkirja, tonne nummerdamata juhiseid, sadu üksteisele saadetavaid e-kirju andmetega, mida tuleb analüüsida ja süsteemseks teha, ja toppida neid samasugustesse lugematutesse tabelitesse.

Ja ja, kui ma natuke jahtusin, otsustasin kirjutada selle artikli. Räägin, kuidas on võimalik korralikult (isegi mõnikord mugavalt) pidada mitmeid mitte-toote dokumente. Loodan, et artikkel levib laialdaselt ja kaotab naaberosakondade hirmud, mis aitavad arenduses, ja inimesed (sh mina) saavad veidi õnnelikumaks.

Tööriistad

Tootedokumentatsioon on sageli koodi lähedal, ja see on hea. Kuid mitte-toote dokumentatsioon on tavaliselt kuskil mujal. Sageli püüavad inimesed andmeid erinevatest kohtadest Confluence'i üle viia, ja meie ei ole erand. Nii et kogu edasine jutt on sellest.

Tegelikult on Confluence arenenud wikiajam. See võimaldab töötada andmetega erinevates visuaalsetes vormides: vormindatud tekst, tabelid, erinevad diagrammid. See on väga huvitav ja võimas tööriist, kuid kui te ei oska seda ette valmistada, siis saate lihtsalt lugematud dokumendid. Ma õpetan teid, kuidas seda teha!

Makrod

Peaaegu kogu Confluence'i võlu tugineb makrode süsteemile. Makroseid on palju ja neid saab omavahel kombineerida. Need võivad olla tasulised või tasuta, ning järgnevates näidetes on toodud erinevad makrod koos nende dokumentatsiooni linkidega.

Makrode kasutajaliides on äärmiselt lihtne. Makro lisamiseks tuleb vajutada plussile ja valida soovitud element loendist.

Kui makro on iseseisev, st ei vaja enda sisse midagi veel, siis näeb see välja nagu plokk.

Kui makro tööks on vajalik midagi sisestada, siis näeb see välja nagu raam.

Samas saab ühe raamiga paigutada nii palju teisi raame, kui tahes, peaasi, et teie püramiidis oleks loogika.

Iga makro puhul on olemas eelvaade: seal näeb kohe, kas olete makro õigesti täitnud ja seadistanud.

Mallid

Lisaks makrodele on olemas mugav sisu eeltäidete tööriist — see on mall.
Malle saab kasutada iga lehe loomisel: lihtsalt vajutage kolmele punktile nuppude „Loo” kõrval ja valige soovitud mall.

Siis lisatakse loodud lehele kogu sisu, mis mallis on.

Lehekülgi saab mallidest luua igaüks, kuid malle endid saab luua või redigeerida vaid need, kellel on selleks õigused. Malli saab lisada täiendavaid juhiseid, kuidas lehekülge haldada.

Käivituslaudade maagia

Tehnika-inimesena armastan ma tõeliselt tabeleid ja saan peaaegu iga teabe nendesse vormida (kuigi see ei ole alati tõhus). Tabelid on iseäranis selged, struktureeritud, skaleeritavad ja maagilised!

Kuid isegi nii imelist asja, nagu tabel, on võimalik rikkuda. Aga seda on ka võimalik edukalt kasutada ja isegi parandada. Selles osas räägime järgmisena.

Filtreerimine (tasuline plugin)

Iga tohutu ja lohakas tabeli saab muuta pisut vähem tohutuks ja pisut rohkem loetavaks filtreerimise abil. Selleks saab kasutada tasulist makrot «Tabeli filter».

Selle makro sisse tuleb sisestada tabel (isegi kõige kohutavam, põhitingimus on see, et see tuleb sisse suruda täielikult). Makros saab valida filtreerimiseks veerge rippmenüüst, tekstifiltri, numbrifiltri ja kuupäevafiltri.

Kujutage ette, et kogu teave kandidaatide kohta kõikide vabade kohtade jaoks on tabelilises loendis. Loomulikult ei ole see sorteeritud — inimesed ei tule vestlusele alfabetsi järjekorras. Ja teil on vaja aru saada, kas olete konkreetse kandidaadi intervjuud varem läbi viinud. Lihtsalt pange see segadus filtrite makrosse, lisage tekstifilter perekonnanime järgi — ja voila, info on ekraanil.

Tasub mainida, et suurte tabelite filtreerimine võib mõjutada süsteemi tööd ja lehe laadimiskiirust, seega suurte tabelite filterdamine on ajutine lahendus; parem on üles ehitada protsess, kus inimestel ei pea olema suuri, loetamatuid tabeleid (protsessi näide tuleb artikli lõpust).

Sorteerimine (tasuline plugin)

maagilise makro abil «Tabeli filter» võite samuti määrata vaikimisi sortimise igas veerus ja numeerida read. Või klõpsates mis tahes veerul filtrile pandud tabelis, toimub sortimine selle veeru järgi.

Näiteks, teil on sama tabel kandidaatidest ja peate hindama, kui palju intervjuusid teatud kuul toimus — järjestage kuupäeva järgi ja nautige.

Kokkuvõtvad tabelid (tasuline plugin)

Liigume nüüd huvitavama juhtumi juurde. Kujutage ette, et teie tabel on tohutu ja peate selle põhjal midagi arvutama. Loomulikult võite selle Excelisse kopeerida, vajaliku välja arvutada ja andmed Confluence'i tagasi laadida. Aga te võite kasutada makrosid. „Kokkuvõtte tabel“ ja saada sama tulemus, vaid see on ka uuendatav.

Näiteks: teil on tabel, kuhu on kogutud kõikide töötajate andmed — kus nad asuvad ja milliseid ametikohti nad täidavad. Et arvutada, kui palju inimesi igas linnas on, peate valima makros „Kokkuvõtte tabel“ rea, mille põhjal andmed koondatakse (asukoht) ja operatsiooni tüübi (liitmine).

Muidugi, saab grupeerida ka mitme tunnuse alusel korraga, kõiki võimalusi saab vaadata. dokumentatsioonist.

Diagrammid (tasuline plugin)

Nagu ma juba ütlesin, ei armasta kõik tabelite koostamist nii nagu mina. Kahjuks ei meeldi enamikule juhtidest need üldse. Kuid kõik armastavad värvilisi diagramme.
Confluence'i loojad teadsid sellest kindlasti (nendel on kindlasti ka ülemus, kes armastab aruandeid ja diagramme, kuidas muidu). Seetõttu saate kasutada maagilist makrot „Diagramm tabelist“. Selle makro jaoks peate lisama eelnevalt loodud kokkuvõttelise tabeli ja voila - teie hallid igavad andmed on kaunilt visualiseeritud.

Loomulikult on selles makros ka seadistused. Viite dokumentatsioonile igasuguste makrode kohta leiate selle makro redigeerimise režiimis.

Andmete kokkusihtumise lihtsus

Eelnevad punktid ei olnud kindlasti teile üllatus. Aga nüüd oskate kindlasti makrosid kasutada ja ma võin minna artikli huvitavama osa juurde.

Märgid

On ebameeldiv, kui inimesed salvestavad teavet ühte mitte-struktureeritud artiklisse või hiiglaslikku tabelisse. Veel hullem on see, kui osa sellest teabest on mitte ainult loetamatult esitatud, vaid ka laiali pillatud Confluence'i avarustes. Õnneks on võimalus koguda laiali valgendatud teave ühte kohta. Selleks tuleb kasutada märke (sotsiaalmeediast tuntud silte).

Iga lehe peale saab lisada suvalise arvu märke. Kui klõpsate märgil, pääsete juurde aggregeerimislehele, kus on lingid kõikidele sellise märgiga materjalidele ja samas ka seotud märkidele. Seotud märgid on need, mis sageli esinevad samal lehel.

Lehe omadused

Lehele saab lisada veel ühe huvitava makro, et struktureerida teavet — „Lehe omadused“. Selle alla tuleb esitada kahe veeruga tabel, kus esimene on võtme, ja teine — omaduse väärtuse. Ja makrot saab lehelt varjata, et see ei segaks sisu lugemist, kuid leht jääb siiski vajalikest võtmetest märgitud.

Pöörake tähelepanu ID-le — seda on mugav määrata, et siduda erinevaid omaduste gruppe erinevate lehtede (või isegi erinevate omaduste gruppe ühe lehega).

Aruanded

Siltide põhjal saab koostada aruandeid. Näiteks makro, „Sisu aruanne“ kogub kõik lehed, millel on teatud siltide kogum.

Kuid huvitavam aruanne on makro, „Lehe omaduste aruanne“. See kogub samuti kõik lehed, millel on teatud siltide kogum, kuid ei väljasta lihtsalt nende nimekirja, vaid koostab tabeli (kas saate seose alguse artikliga?), kus veerud on lehe omaduste võtmed.

Selgub, et see on kokkuvõtte tabel erinevatest allikatest saadud teabe kohta. Tore on see, et sellel on mugavad funktsioonid: kohanduv paigutus, sortimine mis tahes veeru järgi. Samuti saab sellist aruande tabelit konfigureerida makros.

Konfigureerimise ajal saab aruandest eemaldada mõned veerud, määrata vaikeolek või kuvamiste arv. Samuti saab määrata lehe omaduste ID, et näha ainult vajalikku teavet.

Näiteks, teil on palju töötajate lehti, millel on inimene iseloomustav omaduste kogum: mis tasemel ta on, kus ta asub, millal ta meeskonda tuli jms. Need omadused on tähistatud ID = employee_inf. Ja seal on teine omaduste kogum samal lehel, kus on koondatud teave inimese kohta kui meeskonna osa: millist rolli ta täidab, millisest meeskonnast ta on ja nii edasi. Need omadused on tähistatud ID = team_inf. Seega, aruande koostamisel võite kuvada teavet ainult ühe ID kohta või kohe kahe kohta — nagu teile sobib.

Selle lähenemise eel tõsiasi on see, et igaüks saab koostada endale vajalikku teavet sisaldava tabeli, mis ei dubleeri midagi ja uuendatakse peamise lehe värskendamisega. Näiteks: tiimijuhi jaoks ei ole oluline, millal tema arendajad ametisse astusid, vaid oluline on see, millist rolli igaüks neist meeskonnas täidab. Tiimijuht koostab endale aruande meeskonna kohta. Raamatupidajale ei ole aga üldse tähtis, kes millist rolli täidab, vaid oluline on ametikoht — ta koostab endale aruande ametikohtade kohta. Samas allika teavet ei dubleerita ega tõsteta.

Lõpp-protsess

Juhend

Seega saame Confluence'is teavet ilusalt struktureerida ja tõhusalt agrdeerida makrode kasutamise näitel. Kuid ideaalne oleks organiseerida uus teave kohe nii, et see satuks kõigisse juba kasutatavatesse agrdeerimismehhanismidesse.

Siin tuleb appi makrode ja mallide kombinatsioon. Uute lehtede loomise vajalikus vormingus tagamiseks võib kasutada makrot "Loo mallist". See lisab lehele nupu, millele vajutades luuakse uus leht teie soovitud mallist. Sel viisil motiveerite inimesi kohe teie soovitud vormingus töötama.

Mall, millest soovite lehte luua, peab olema eelnevalt varustatud märksõnadega, makro "Lehe omadused" ja vajalike omaduste tabeliga. Soovitan lisada ka juhiseid, milliste väärtustega lehte täita ja omaduste väärtusi.

Siis näeb lõppprotsess välja järgmiselt:

Loote teatud tüüpi teabe jaoks malli.
Sellesse mallisse lisate omadused ja lehe omadused makros.
Loote juurpäev lemmikpaika koos nupuga, mida vajutades luuakse alamsait malli põhjal.
Suunate juurpäevale kasutajad, kes potentsiaalselt genereerivad vajalikke andmeid (vajalikus mallis nupu vajutamisega).
Kogute aruande lehe omadustest läbi siltide, mille olete malli seadnud.
Olete rõõmus: teil on kogu vajalik teave mugavas formaadis.

Peidetud probleemid

Kvaliteediinsenerina võin julgelt väita, et maailmas ei ole midagi ideaalset. Ievened tabelid pole täiuslikud. Ja eespool mainitud protsessis on varjatud ohud.

Kui otsustate muuta lehe omaduste nimesid või sisu, peate uuendama kõiki juba loodud objekte, et nende andmed õigselt kokkuvõtete aruanne tõmmatakse. See on kurb, aga teisest küljest sunnib see teid põhjalikult mõtlema oma teabe 'arhitektuurile', mis on üsna huvitav ülesanne.
Kasutajatel tuleb kirjutada piisavalt juhiseid selle kohta, kuidas täita teabelehti ja kasutada sildisid. Teisest küljest võite lihtsalt jagada seda artiklit kõigile, kes vajavad.

Näide mitte-toote dokumentatsiooni säilitamisest

Ülaltoodud protsessi abil saab korraldada peaaegu igasuguste andmete säilitamise. Selle lähenemise ilu seisneb universaalsuses: kui kasutajad harjuvad, lakkavad nad segaduse tekitamisest. Samuti on suur (aga mitte tasuta) boonus — võimalus koguda reaalajas mitmesugust statistikat ja joonistada selle järgi ilusaid diagramme.

Tõin näite meie meeskonna infohalduse protsessist.

Iga meeskonna liikme jaoks otsustasime luua töötaja kaardi. Vastavalt on meil šabloon, mille alusel iga uus liige loob endale selle kaardi ja haldab seal kogu isikuandmeid.

Nagu näete, on meil ulatuslik omaduste tabel ja kohe on kirjas juhised, kuidas seda lehte pidada. Osa silte määrab ise töötajad juhiste järgi, šabloonis on ainult põhilised: kaardi silt employee-card, valdkonna silt direction-involve ja ja meeskonna meeskonna-qa.

Lõpuks, kui igaühel on oma kaart loodud, saame täis tabeli töötajate teabega. Seda informatsiooni saab kasutada erinevates kohtades. Ressursside juhid saavad koostada üldtabeleid ja meeskondade juhid — meeskonna tabeleid, lisades valikusse meeskonna sildi.

Siltide järgi saab näha erinevaid kokkuvõtteid, näiteks qa-täiendamisplaan kuvatakse kõik ülesanded QA arendamiseks. Igaühel on oma töötaja kaardil oluline lugu ja arenguplaan — luuakse sisemine leht arenguplaanide mallist.