Visiem sveiki!
Mani sauc MaÅ”a, es strÄdÄju kvalitÄtes nodroÅ”inÄÅ”anas inženiera amatÄ Tinkoff grupÄ. QA darbs prasa daudz komunikÄcijas ar dažÄdiem cilvÄkiem no dažÄdÄm komandÄm, bet es arÄ« biju menedžeris un izglÄ«tÄ«bas programmu lektors, tÄpÄc mana komunikÄcijas karte bija maksimÄli plaÅ”a. Un kÄdÄ brÄ«dÄ« es izsÄ«ku: sapratu, ka vairs nespÄju, nespÄju, nespÄju aizpildÄ«t ellÄ«gas tonnas neizlasÄmu tabulu un dokumentu.

Noteikti katrs no jums tagad iedomÄjÄs to, par ko runÄju, un izsita aukstu sviedru: uzvÄrdu saraksti bez alfabÄtiska kÄrtÄ«bas, tabulas ar simtiem kolonu un sagÄjuÅ”Äm formÄm, tabulas ar tÅ«kstoÅ”iem rindu, kurÄs jÄtÄ«ra pirksts pret peli, lai redzÄtu virsrakstu, tonnas nesakÄrtotu instrukciju lapu, simtiem sÅ«tÄ«to e-pastu ar datiem, kas jÄsaprot un sistÄmaskÄ jÄieliek tikpat neizlasÄmÄs tabulÄs.

Un tad, kad es nedaudz atdzisu, nolÄmu uzrakstÄ«t Å”o rakstu. PastÄstīŔu par to, kÄ var normÄli (dažkÄrt arÄ« Ärti) veikt dažÄdu netehnisku dokumentÄciju. Ceru, ka raksts izplatÄ«sies pa tÄ«klu un netehniskÄs nodaļÄs blakus izstrÄdei situÄcija nedaudz uzlabosies, un cilvÄki (arÄ« es) kļūs nedaudz laimÄ«gÄki.

Rīki
Produktu dokumentÄcija bieži tiek glabÄta blakus kodam, un tas ir labi. Bet netehniskÄ dokumentÄcija parasti tiek glabÄta visur. Bieži cilvÄki cenÅ”as pÄrvietot informÄciju no dažÄdÄm vietÄm uz Confluence, un mÄs neesam izÅÄmums. TÄpÄc turpmÄkÄ stÄstÄ«juma temats bÅ«s par to.
KopumÄ Confluence ir uzlabota viki dzineja. Tas ļauj strÄdÄt ar datiem dažÄdos attÄlojuma veidos: formatÄts teksts, tabulas, dažÄdas diagrammas. Tas ir ļoti interesants un jaudÄ«gs rÄ«ks, bet, ja neprot to sagatavot, jÅ«s saÅemat vÄl vienu neizlasÄmu dokumentu Äupu. Es jums mÄcīŔu to sagatavot!

Makro
GandrÄ«z visa Confluence burvÄ«ba balstÄs uz makro. Ir ļoti daudz makro, un tos var kombinÄt savÄ starpÄ. Tie ir maksas un bezmaksas, tiks sniegti dažÄdi makro piemÄri ar saistÄ«tajiem dokumentÄcijÄm.
Darba ar makro saskarne ir pÄc iespÄjas vienkÄrÅ”Äka. Lai pievienotu makro, jums jÄnospiež uz plusa un jÄizvÄlas nepiecieÅ”amais elements no saraksta.

Ja makro ir paÅ”pietiekams, tas izskatÄs kÄ bloks.

Ja makro darbÄ«bai nepiecieÅ”ams kaut kas, lai to ievietotu, tas izskatÄs kÄ rÄmis.

TaÄu vienÄ rÄmÄ« var ievietot tik daudz citu, kamÄr jÅ«su hierarhijÄ ir loÄ£ika.

Katram makro ir priekÅ”skatÄ«jums: tajÄ ir uzreiz redzams, vai jÅ«s pareizi esat aizpildÄ«jis un iestatÄ«jis makro.
Veidnes
Papildus makro ir Ärts kontenta priekÅ”apliekoÅ”anas rÄ«ks ā tas ir veidne.
Veidnes var izmantot, veidojot jebkuru lapu: vienkÄrÅ”i noklikŔķiniet uz trim punktiem blakus pogai āIzveidotā un izvÄlieties vajadzÄ«go veidni.

Tad izveidotajÄ lapÄ tiks pievienots viss saturs, kas ir veidnÄ.
LapÄm no veidnÄm var izveidot jebkurÅ”, bet veidnes izveidot vai rediÄ£Ät var tikai tie, kuriem ir tam tiesÄ«bas. VeidnÄ var pievienot papildus instrukcijas par to, kÄ jÄrÄ«kojas lapai.

Tabulu burvība
PatiesÄ«bÄ es, kÄ tehniÄ·is, mÄ«lu tabulas un varu gandrÄ«z jebkuru informÄciju tajÄs ietvert (lai gan tas ne vienmÄr ir efektÄ«vi). PaÅ”as tabulas ir skaidras, strukturÄtas, mÄrogojamas, burvÄ«gas!

Bet pat tÄdu lielisku bÅ«tni kÄ tabulu var sabojÄt. TaÄu ir iespÄjams to veiksmÄ«gi izmantot un pat uzlabot. Par to rakstīŔu tÄlÄk.
FiltrÄÅ”ana (maksas spraudnis)
Jebkuru milzÄ«gu, nekontrolÄjamu tabulu var padarÄ«t nedaudz mazÄku un nedaudz lasÄmÄku, izmantojot filtrÄÅ”anu. To var izdarÄ«t ar maksas makro .
Å ajÄ makro jÄievieto tabula (vÄlams visneglÄ«tÄkÄ, galvenais ā ievietot to visu). Makro var izvÄlÄties filtrÄjamos kolonnas no nolaižamÄ saraksta, teksta filtra, skaitļu un datumu filtra.

IedomÄjieties, ka visa informÄcija par kandidÄtiem uz visÄm vakancÄm tiek ierakstÄ«ta tabulas formÄtÄ. Protams, neiedalot pÄc kÄrtÄ«bas ā cilvÄki taÄu neapmeklÄ intervijas pÄc alfabÄta. Un jums jÄnoskaidro, vai esat iepriekÅ” runÄjis ar konkrÄtu pretendentu. Jums vienkÄrÅ”i jÄievieto Å”is bardaks filtrÄjoÅ”ajÄ makro, jÄpievieno teksta filtrs pÄc uzvÄrda ā un voila, informÄcija ir jÅ«su ekrÄnÄ.

JÄatzÄ«mÄ, ka milzÄ«gu tabulu filtrÄÅ”ana var ietekmÄt sistÄmas darbÄ«bu un lapu ielÄdes laiku, tÄpÄc ievietot milzÄ«gu tabulu filtrÄ ir Ä«slaicÄ«ga pieeja, labÄk izveidot procesu, kurÄ cilvÄkiem nav jÄveido milzÄ«gas, grÅ«ti lasÄmas tabulas (procesa piemÄrs bÅ«s raksta beigÄs).
KÄrtot (maksas spraudnis)
Izmantojot burvju makro , var arÄ« iestatÄ«t noklusÄjuma kÄrtÄ«bu pÄc jebkura staba un numurÄt rindas. Vai arÄ« vienkÄrÅ”i nospiest uz jebkura staba tabulÄ, kas ievietota filtrÄÅ”anas makro, un notiks kÄrtoÅ”ana pÄc Ŕī staba.

PiemÄram, jums ir tÄ pati tabula ar kandidÄtiem, un ir jÄizdomÄ, cik daudz sarunu ir notikuÅ”i noteiktajÄ mÄnesÄ« ā kÄrtojiet pÄc datuma un priecÄjieties.
Kopsavilkuma tabulas (maksas spraudnis)
Tagad pÄriesim pie interesantÄkÄ gadÄ«juma. IedomÄjieties, ka jÅ«su tabula ir milzÄ«ga un nepiecieÅ”ams kaut ko aprÄÄ·inÄt. Protams, to var kopÄt uz Excel, aprÄÄ·inÄt nepiecieÅ”amo un augÅ”upielÄdÄt datus atpakaļ Confluence. TaÄu var vienreiz piemÄrot makro un iegÅ«t to paÅ”u rezultÄtu, tikai vÄl arÄ« atjaunojamu.
PiemÄram: jums ir tabula, kurÄ apkopota visu darbinieku informÄcija ā kur tie Ä£eogrÄfiski atrodas un kÄdas amatus ieÅem. Lai aprÄÄ·inÄtu, cik cilvÄku atrodas katrÄ pilsÄtÄ, jums jÄizvÄlas makros āKopsavilkuma tabulaā rinda, pÄc kuras apkopot datus (vietojums) un operÄcijas veids (saskaitīŔana).

Dabiski, grupÄÅ”ana var notikt pÄc vairÄkiem kritÄrijiem vienlaikus, visas iespÄjas var aplÅ«kot .
Diagrammas (maksas spraudnis)
KÄ jau teicu, ne visi tik ļoti mÄ«l tabulas kÄ es. DiemžÄl menedžeri lielÄkoties tÄs nemÄ«l vispÄr. Toties visi ļoti mÄ«l krÄsainas, spilgtas diagrammas.
Confluence radÄ«tÄji par to, protams, zinÄja (viÅiem noteikti arÄ« ir vadÄ«ba, kas mÄ«l ziÅojumus un diagrammas, kur tÄ bez tÄ). TÄdÄļ var izmantot burvju makro . Å ajÄ makro jÄievieto iepriekÅ”ÄjÄ punkta kopsavilkuma tabula, un voilĆ ā jÅ«su pelÄkie, garlaicÄ«gie dati ir skaisti vizualizÄti.

Dabiski, Å”ajÄ makro arÄ« ir iestatÄ«jumi. Saiet uz dokumentÄciju par jebkuru makro var atrast, rediÄ£Äjot Å”o makro.
ApvienoÅ”anas vienkÄrŔība
IepriekÅ”Äjo punktu informÄcija, iespÄjams, jums nebija jaunums. TaÄu tagad jÅ«s noteikti zinÄt, kÄ izmantot makros, un es varu pÄriet uz interesantÄku raksta daļu.

EtiÄ·etes
Ir slikti, kad cilvÄki glabÄ informÄciju vienÄ strukturÄtÄ rakstÄ vai milzÄ«gÄ tabulÄ. VÄl sliktÄk ā kad daļa no Ŕīs informÄcijas ne tikai ir neskaidri noformÄta, bet arÄ« izkaisÄ«ta pa Confluence. Par laimi, ir iespÄja apkopot izkaisÄ«to informÄciju vienÄ vietÄ. Lai to izdarÄ«tu, jums ir jÄizmanto (pazÄ«stamas visiem sociÄlajos tÄ«klos kÄ tagi).

Jebkurai lapai var pievienot neierobežotu skaitu atzÄ«mju. Ja noklikŔķinÄsiet uz atzÄ«mes, nokļūsiet agregÄcijas lapÄ, kur ir saites uz visiem materiÄliem ar Å”o atzÄ«mi, kÄ arÄ« uz saistÄ«tÄm atzÄ«mÄm. SaistÄ«tÄs atzÄ«mes ir tÄs, kuras bieži parÄdÄs vienÄ lapÄ.

Lapu īpaŔības
Uz lapu var pievienot vÄl vienu interesantu makro, kas palÄ«dz strukturÄt informÄciju ā . TajÄ ir jÄievada tabula ar divÄm kolonnÄm, pirmajÄ bÅ«s atslÄga, bet otrajÄ ā Ä«paŔības vÄrtÄ«ba. TurklÄt makro var slÄpt no lapas, lai tas netraucÄtu lasÄ«t saturu, bet lapai joprojÄm bÅ«s pareizi atzÄ«mÄtas atslÄgas.

PievÄrsiet uzmanÄ«bu ID ā to Ärti noteikt, lai pieŔķirtu dažÄdas Ä«paŔību grupas dažÄdÄm lapÄm (vai pat dažÄdas Ä«paŔību grupas vienai lapai).
ZiÅojumi
SaskaÅÄ ar atzÄ«mÄm var veidot ziÅojumus. PiemÄram, makro apkopo visas lapas ar noteiktu atzÄ«mju kopu.

TomÄr interesantÄks ir ziÅojums, kas nÄk no makro . Tas arÄ« apkopo visas lapas ar noteiktu atzÄ«mju kopu, bet ne tikai izvada to sarakstu, bet arÄ« sastÄda tabulu (sajÅ«ta, ka saistÄmies ar raksta sÄkumu?), kurÄs kolonnas ir lapas Ä«paŔību atslÄgas.

RezultÄtÄ veidojas konsolidÄta tabula ar informÄciju no dažÄdiem avotiem. PatÄ«kami, ka tai ir Ärti funkcionÄlÄs iespÄjas: adaptÄ«vÄ izkÄrtojums, ŔķiroÅ”ana pÄc jebkuras kolonnas. Å Ädu ziÅojumu tabulu var konfigurÄt arÄ« makros.

KonfigurÄjot, varat izslÄgt dažu kolonnu no ziÅojuma, noteikt noklusÄjuma stÄvokli vai attÄlojamo ierakstu skaitu. Var arÄ« definÄt lapas Ä«paŔības ID, lai redzÄtu tikai nepiecieÅ”amo informÄciju.
PiemÄram, jums ir daudz darbinieku lapu, un Ŕīm lapÄm ir virknes Ä«paŔību par personu: kÄdÄ lÄ«menÄ« viÅÅ” atrodas, kur viÅÅ” atrodas, kad pievienojÄs komandai un tÄ tÄlÄk. Å Ä«s Ä«paŔības ir atzÄ«mÄtas ID = employee_inf. Un ir otra Ä«paŔību grupa uz tÄs paÅ”as lapas, kur apkopota informÄcija par personu kÄ komandas daļu: kÄdu lomu persona veic, kÄdÄ komandÄ viÅa atrodas un tÄ tÄlÄk. Å Ä«s Ä«paŔības ir atzÄ«mÄtas ID = team_inf. TÄtad, veidojot ziÅojumu, jÅ«s varat izvadÄ«t informÄciju tikai par vienu ID vai uzreiz par abiem ā kÄ ÄrtÄk.
Å Ä« pieeja ir pievilcÄ«ga, jo ikviens var izveidot sev nepiecieÅ”amo informÄcijas tabulu, kas nekÄdÄ veidÄ netiks dublÄta un tiks atjauninÄta, kad atjauninÄs galveno lapu. PiemÄram, komandas lÄ«derim nav svarÄ«gi, kad viÅa izstrÄdÄtÄji pievienojÄs darba videi, bet ir svarÄ«gi, kÄdu lomu katrs no viÅiem veic komandÄ. Komandas lÄ«deris izveidos sev ziÅojumu par komandu. Bet grÄmatvedim vispÄr nav svarÄ«gi, kas kÄdu lomu veic, bet svarÄ«gas ir amatu nosaukumi ā viÅÅ” izveidos sev ziÅojumu par amatiem. TajÄ paÅ”Ä laikÄ informÄcijas avots netiks dublÄts vai pÄrvietots.
Galīgais process
NorÄdÄ«jums
TÄtad, mÄs varam skaisti strukturÄt un efektÄ«vi apkopot informÄciju Confluence, izmantojot makros. Bet ideÄlÄ gadÄ«jumÄ jÄpanÄk, lai jaunÄ informÄcija uzreiz bÅ«tu strukturÄta un iekļautos visos jau izmantotajos apkopojuma mehÄnismos.
Å eit palÄ«dzÄs makro un veidÅu kombinÄcija. Lai mudinÄtu cilvÄkus izveidot jaunas lapas pareizajÄ formÄtÄ, varat izmantot makro āIzveidot pÄc veidnesā. Tas pievieno lapai pogu, uz kuras nospiežot tiek izveidota jauna lapa, izmantojot jums nepiecieÅ”amo veidni. TÄdÄjÄdi jÅ«s liekat cilvÄkiem uzreiz strÄdÄt jums vajadzÄ«gajÄ formÄtÄ.

VeidnÄ, no kuras pieļaujama lappuÅ”u izveide, iepriekÅ” jÄiekļauj etiÄ·etes, makro āLappuses Ä«paŔībasā un tabula ar jums nepiecieÅ”amajiem Ä«paŔībÄm. TÄpat iesaku pievienot instrukcijas, kÄdiem vÄrtÄ«bÄm jÄbÅ«t lapÄ, un Ä«paŔību vÄrtÄ«bas.

Tad galÄ«gais process izskatÄ«sies Å”Ädi:
- JÅ«s izveidojat veidni konkrÄta veida informÄcijai.
- Å ajÄ veidnÄ pievienojat etiÄ·etes un lappuses Ä«paŔības makros.
- JebkurÄ ÄrtÄ vietÄ izveidojiet saknes lapu ar pogu, kuru nospiežot, tiek izveidota apakÅ”lapas no Å”ablona.
- UzbÅ«vÄjiet saknes lapu lietotÄjiem, kuri potenciÄli varÄs Ä£enerÄt nepiecieÅ”amo informÄciju (saskaÅÄ ar vajadzÄ«go Å”ablonu, nospiežot uz pogas).
- SavÄciet sev ziÅojumu par lapas Ä«paŔībÄm, izmantojot etiÄ·etes, kuras esat norÄdÄ«jis Å”ablonÄ.
- PriecÄjaties: jums ir visa nepiecieÅ”amÄ informÄcija ÄrtÄ formÄtÄ.

ZemÅ«dens akmeÅi
KÄ kvalitÄtes inženieris, es droÅ”i varu apgalvot, ka nav nekÄ ideÄla pasaulÄ. Pat dieviŔķie dati nav ideÄli. Un iepriekÅ”minÄtajÄ procesÄ ir zemÅ«dens akmeÅi.
- Ja nolemsiet mainÄ«t nosaukumus vai Ä«paŔību sastÄvu lapÄ, jums bÅ«s jÄatjaunina visi jau izveidotie objekti, lai to dati pareizi parÄdÄ«tos apkopotajÄ ziÅojumÄ. Tas ir žÄl, taÄu, no otras puses, tas liek detalizÄti pÄrdomÄt jÅ«su informÄcijas kopuma "arhitektÅ«ru", kas ir ļoti interesants uzdevums.
- Jums bÅ«s jÄraksta pienÄcÄ«gs skaits norÄdÄ«jumu par to, kÄ aizpildÄ«t informÄcijas tabulas un izmantot etiÄ·etes. TaÄu, no otras puses, jÅ«s varat vienkÄrÅ”i nosÅ«tÄ«t visiem interesentiem Å”o rakstu.
NesaskaÅota dokumentÄcijas uzglabÄÅ”anas piemÄrs
Caurs iepriekÅ”minÄto procesu ir iespÄjams organizÄt gandrÄ«z jebkuras informÄcijas uzglabÄÅ”anu. PievilcÄ«ba pieejai ir tÄ, ka tÄ ir universÄla: kad lietotÄji pie tÄs pierod, viÅi pÄrstÄj Ä£enerÄt haosu. ArÄ« liels (bet ne bezmaksas) bonuss ir iespÄja savÄkt daudzveidÄ«gu statistiku un zÄ«mÄt skaistas diagrammas.
NorÄdīŔu piemÄru par mÅ«su informÄcijas uzskaiti par komandu.

Katram cilvÄkam komandÄ mÄs nolÄmÄm izveidot darbinieka karti. AttiecÄ«gi, mums ir Å”ablons, pÄc kura katrs jauns cilvÄks izveido Å”o karti un vada tajÄ visu personisko informÄciju.

KÄ redzat, mums ir izsmeļoÅ”a Ä«paŔību tabula, un uzreiz ir norÄdÄ«jumi par to, kÄ tieÅ”i uzturÄt Å”o lapu. Daļu etiÄ·eÅ”u norÄda paÅ”i darbinieki pÄc norÄdÄ«jumiem, Å”ablonÄ tikai galvenÄs: etiÄ·ete kartes employee-card, etiÄ·ete virziena direction-involve un etiÄ·ete komandas team-qa.
RezultÄtÄ, kad katrs ir izveidojis savu karti, tiek iegÅ«ta pilna tabula ar informÄciju par darbiniekiem. Å o informÄciju var izmantot dažÄdÄs vietÄs. Resursu vadÄ«tÄji var izveidot kopÄ«gas tabulas, bet komandu vadÄ«tÄji ā komandu tabulas, pievienojot atlasi komandas tagu.
PÄc tagiem var redzÄt dažÄdas apkopes, piemÄram, pÄc qa-upgrade-plan tiks parÄdÄ«tas visas uzdevumu attÄ«stÄ«bai QA. Katram cilvÄkam viÅa darbinieka kartÄ ir svarÄ«ga vÄsture un attÄ«stÄ«bas plÄns ā izveidojot iekļauto lapu no attÄ«stÄ«bas plÄnu Å”ablona.

SecinÄjums
IzstrÄdÄjiet jebkuru dokumentÄciju tÄ, lai par to nebÅ«tu kauns, un lietotÄjiem nebÅ«tu mokoÅ”i sÄpÄ«gi!
Ä»oti ceru, ka raksts bÅ«s noderÄ«gs un visÄs pasaules dokumentÄcijÄs iestÄsies kÄrtÄ«ba.

Avots: habr.com
