Sveiki visiem!
Mani sauc Maša, es strādāju par kvalitātes nodrošināšanas inženieri Tinkoff uzņēmumu grupā. QA darbs ir saistīts ar lielu komunikāciju ar dažādiem cilvēkiem no dažādām komandām, turklāt biju arī izglītības programmu vadītāja un pasniedzēja, tāpēc mana komunikācijas karte bija pēc iespējas plašāka. Un kādā brīdī es eksplodēju: es sapratu, ka es nevaru, es nevaru, es nevaru aizpildīt elles tonnas nelasāmu tabulu un dokumentu.
Noteikti katrs no jums tagad ir iedomājies, par ko es runāju, un izplūduši aukstos sviedros: uzvārdu saraksti bez alfabēta secības, tabulas ar simtiem kolonnu ar greizu izkārtojumu, tabulas ar tūkstošiem rindu, kurās jānoslauka pirksts. uz peles ritenīša, lai skatītos galveni, tonnām nenumerētu instrukciju lappušu, simtiem vēstuļu, kas nosūtītas viena otrai ar datiem, kas jāanalizē un jāsistematizē un jāievieto tikpat nesalasāmās tabulās.
Un tā, kad nedaudz atvēsinājos, nolēmu uzrakstīt šo rakstu. Es runāšu par to, kā jūs varat normāli (pat dažreiz ērti) uzturēt dažādu ar produktu nesaistītu dokumentāciju. Ceru, ka raksts izplatīsies pa internetu un elles līmenis attīstībai blakus esošajās nodaļās vismaz nedaudz pazemināsies, un cilvēki (arī es pats) kļūs mazliet laimīgāki.
Darbarīki
Produkta dokumentācija bieži tiek glabāta blakus kodam, kas ir labi. Un ar produktu nesaistīta dokumentācija parasti tiek glabāta jebkur. Cilvēki bieži mēģina pārvietot informāciju no dažādām vietām uz Confluence, un mēs neesam izņēmums. Tātad pārējais stāsts ir par viņu.
Kopumā Confluence ir uzlabots wiki dzinējs. Tas ļauj strādāt ar datiem dažāda veida displejos: teksts ar formatējumu, tabulas, dažādas diagrammas. Šis ir ļoti interesants un jaudīgs rīks, taču, ja nezināt, kā to sagatavot, jūs nonāksit pie kārtējās nelasāmu dokumentu izgāztuves. Es tev iemācīšu gatavot!
Makro
Gandrīz visa Confluence maģija nāk no makro. Makro ir daudz, un tos var kombinēt savā starpā. Tie var būt maksas vai bezmaksas; tālāk būs dažādi makro piemēri ar saitēm uz to dokumentāciju.
Saskarne darbam ar makro ir pēc iespējas vienkāršāka. Lai pievienotu makro, jums jānoklikšķina uz pluszīmes un sarakstā atlasiet vajadzīgo elementu.
Ja makro ir autonoms, tas ir, tajā nav jāievieto nekas cits, tas izskatās kā bloks.
Ja makro ir nepieciešams kaut kas tajā ievietots, lai tas darbotos, tas izskatās kā rāmis.
Tajā pašā laikā vienā kadrā varat ievietot tik daudz citu, cik vēlaties, ja vien jūsu piramīdā ir loģika.
Katram makro ir priekšskatījums: tas uzreiz parāda, vai makro aizpildījāt un konfigurējāt pareizi.
veidnes
Papildus makro ir pieejams ērts satura priekšaizpildīšanas rīks - veidne.
Veidnes var izmantot, veidojot jebkuru lapu: vienkārši noklikšķiniet uz trim punktiem blakus pogai “Izveidot” un atlasiet vajadzīgo veidni.
Pēc tam viss saturs, kas atrodas veidnē, tiks pievienots izveidotajai lapai.
Ikviens var izveidot lapas no veidnēm, taču to var darīt tikai tie, kuriem ir tiesības pašiem izveidot vai rediģēt veidnes. Veidnei varat pievienot papildu norādījumus par lapas uzturēšanu.
Galdu burvība
Patiesībā man kā tehniķim ļoti patīk tabulas un tajās varu ietīt gandrīz jebkuru informāciju (lai gan tas ne vienmēr ir efektīvi). Pašas tabulas ir skaidras, strukturētas, mērogojamas, maģiskas!
Bet pat tik brīnišķīgu vienību kā galdu var sabojāt. Un jūs varat to veiksmīgi izmantot un pat uzlabot. Vairāk par to zemāk.
Filtrēšana (maksas spraudnis)
Jebkuru milzīgu, nelasāmu tabulu var padarīt nedaudz mazāk lielu un nedaudz lasāmāku, izmantojot filtrēšanu. Šim nolūkam varat izmantot maksas makro .
Šajā makro jāieliek iekšā tabula (pat neglītākais ir iespējams, galvenais ir iebīdīt pilnībā). Makro varat atlasīt kolonnas nolaižamajam filtram, teksta filtram, ciparu filtram un datuma filtram.
Iedomājieties, ka visa informācija par kandidātiem uz visām vakancēm tiek ierakstīta tabulas sarakstā. Dabiski, nešķiroti – cilvēki nāk uz intervijām nevis alfabēta secībā. Un jums ir jāsaprot, vai esat iepriekš intervējis konkrētu pretendentu. Jums vienkārši jāievieto šī elle filtra makro, jāpievieno teksta filtrs pēc uzvārda — un voila, informācija ir jūsu ekrānā.
Ir vērts atzīmēt, ka lielu tabulu filtrēšana var ietekmēt sistēmas veiktspēju un lapu ielādes laiku, tāpēc lielas tabulas ievietošana filtrā ir īslaicīgs kruķis; labāk ir izveidot procesu, kurā cilvēkiem nav jāveido milzīgas, nelasāmas tabulas ( procesa piemērs būs raksta beigās).
Kārtošana (maksas spraudnis)
Burvju makro izmantošana Varat arī iestatīt noklusējuma kārtošanu jebkurā kolonnā un numurēt rindas. Vai noklikšķiniet uz jebkuras tabulas kolonnas, kas ievietota filtra makro, un kārtošana tiks veikta pēc šīs kolonnas.
Piemēram, jums ir viena tabula ar pretendentiem, un jums ir jānovērtē, cik interviju tika veiktas noteiktā mēnesī – šķirojiet pēc datuma un priecājieties.
Rakurstabulas (maksas spraudnis)
Tagad pāriesim pie interesantāka gadījuma. Iedomājieties, ka jūsu galds ir milzīgs un jums no tā kaut kas jāaprēķina. Protams, varat tos kopēt programmā Excel, aprēķināt nepieciešamo un augšupielādēt datus atpakaļ Confluence. Vai varat izmantot makro vienreiz? un iegūt tādu pašu rezultātu, tikai atjaunināts.
Piemēram: jums ir tabula, kurā tiek apkopoti dati par visiem darbiniekiem - kur viņi atrodas un kādus amatus viņi ieņem. Lai aprēķinātu, cik cilvēku ir katrā pilsētā, rakurstabulas makro ir jāatlasa rinda, kurā tiek apkopoti dati (atrašanās vieta) un darbības veids (papildinājums).
Dabiski, ka var grupēt pēc vairākiem kritērijiem uzreiz, visas iespējas var apskatīt .
Diagrammas (maksas spraudnis)
Kā jau teicu, ne visi mīl galdus tik ļoti kā es. Diemžēl lielākajai daļai vadītāju tie nemaz nepatīk. Bet visiem ļoti patīk spilgtas krāsas diagrammas.
Confluence veidotāji noteikti par to zināja (viņiem droši vien ir arī priekšnieki, kuriem patīk atskaites un diagrammas, kur gan viņi būtu bez tā). Tāpēc varat izmantot burvju makro . Šajā makro ir jāievieto rakurstabula no iepriekšējās rindkopas, un voila - jūsu pelēkie garlaicīgie dati ir lieliski vizualizēti.
Protams, šim makro ir arī iestatījumi. Saite uz jebkura makro dokumentāciju ir atrodama attiecīgā makro rediģēšanas režīmā.
Viegla apkopošana
Iespējams, ka informācija no iepriekšējām rindkopām jums nebija atklājums. Bet tagad jūs noteikti zināt, kā izmantot makro, un es varu pāriet uz interesantāko raksta daļu.
Uzlīmes
Ir slikti, ja cilvēki informāciju glabā vienā nestrukturētā rakstā vai milzīgā tabulā. Tas ir vēl sliktāk, ja šīs informācijas daļas ir ne tikai nesalasāmi formatētas, bet arī izkaisītas visā Confluence. Par laimi, ir iespējams apkopot izkaisītu informāciju vienuviet. Lai to izdarītu, jums ir jāizmanto (atzīmes, kas visiem pazīstamas no sociālajiem tīkliem).
Jebkurai lapai varat pievienot neierobežotu skaitu atzīmju. Noklikšķinot uz atzīmes, tiks atvērta apkopošanas lapa ar saitēm uz visu saturu ar šo tagu, kā arī uz saistītu tagu kopu. Saistītie tagi ir tie, kas bieži parādās vienā lapā.
Lapas rekvizīti
Lai strukturētu informāciju, lapai varat pievienot vēl vienu interesantu makro - . Tajā jāiesniedz tabula ar divām kolonnām, pirmā būs atslēga, bet otrā būs īpašuma vērtība. Turklāt makro var paslēpt no lapas, lai tas netraucētu lasīt saturu, bet lapa tik un tā tiks atzīmēta ar nepieciešamajiem taustiņiem.
Pievērsiet uzmanību ID – to ir ērti iestatīt, lai dažādām lapām piešķirtu dažādas rekvizītu grupas (vai vienai lapai pat dažādas rekvizītu grupas).
ziņojumi
Varat apkopot pārskatus, izmantojot tagus. Piemēram, makro apkopo visas lapas ar noteiktu tagu kopu.
Bet interesantāks ziņojums ir makro . Tas arī apkopo visas lapas ar noteiktu tagu kopu, bet ne tikai parāda to sarakstu, bet izveido tabulu (vai jūs uztverat saikni ar raksta sākumu?), kurā kolonnas ir lapa īpašuma atslēgas.
Rezultāts ir apkopota tabula ar informāciju no dažādiem avotiem. Patīkami, ka tai ir ērtas funkcijas: adaptīvs izkārtojums, kārtošana pēc jebkuras kolonnas. Arī šādu pārskatu tabulu var konfigurēt makro iekšienē.
Konfigurējot, varat noņemt no pārskata dažas kolonnas, iestatīt noklusējuma stāvokli vai parādīto ierakstu skaitu. Varat arī iestatīt lapas īpašuma ID, lai redzētu tikai jums nepieciešamo informāciju.
Piemēram, jums ir daudz darbinieku lapu, šajās lapās ir īpašību kopums par personu: kāds ir viņa līmenis, kur viņš atrodas, kad viņš pievienojās komandai utt. Šīs īpašības ir atzīmētas ID = darbinieka_informācija. Un tajā pašā lapā ir otrs rekvizītu kopums, kurā ir informācija par personu kā komandas daļu: kādu lomu persona spēlē, kurā komandā viņš ir utt. Šīs īpašības ir atzīmētas ID = team_inf. Pēc tam, sastādot atskaiti, uzreiz var attēlot informāciju tikai vienam vai diviem ID – kā nu kuram ērtāk.
Šīs pieejas skaistums ir tāds, ka ikviens var salikt sev nepieciešamo informācijas tabulu, kas neko nedublēs un tiks atjaunināta, kad tiks atjaunināta galvenā lapa. Piemēram: komandas vadītājam nav svarīgi, kad viņa izstrādātāji dabūja darbu, bet gan ir svarīgi, kāda loma komandā ir katram no viņiem. Komandas vadītājs savāks atskaiti par komandu. Un grāmatvedim parasti ir vienalga, kurš kādu lomu pilda, bet amati ir svarīgi - viņš sastādīs pārskatu par amatiem. Šajā gadījumā informācijas avots netiks dublēts vai pārsūtīts.
Beigu process
Norādījums
Tādējādi mēs varam skaisti strukturēt un efektīvi apkopot informāciju Confluence, izmantojot makro kā piemēru. Bet ideālā gadījumā jums ir jāpārliecinās, ka jaunā informācija tiek nekavējoties strukturēta un ietilpst visos jau izmantotajos apkopošanas mehānismos.
Šeit palīgā nāks virkne makro un veidņu. Lai piespiestu cilvēkus izveidot jaunas lapas vēlamajā formātā, varat izmantot makro Izveidot no veidnes. Tā lapai pievieno pogu, noklikšķinot, no vajadzīgās veidnes tiek izveidota jauna lapa. Tādā veidā jūs piespiežat cilvēkus nekavējoties strādāt jums vajadzīgajā formātā.
Veidnē, no kuras veidojat lapu, iepriekš jāpievieno etiķetes, makro “Lapas rekvizīti” un vajadzīgo rekvizītu tabula. Iesaku arī pievienot norādījumus par to, kādas vērtības ir jāaizpilda lapā, un rekvizītu vērtībām.
Tad pēdējais process izskatīsies šādi:
- Jūs izveidojat veidni noteikta veida informācijai.
- Šajā veidnē makro pievienojat iezīmes un lapas rekvizītus.
- Jebkurā ērtā vietā izveidojiet saknes lapu ar pogu, uz kuras noklikšķinot, no veidnes tiek izveidota bērna lapa.
- Jūs ļaujat lietotājiem doties uz saknes lapu, kas potenciāli ģenerēs nepieciešamo informāciju (saskaņā ar nepieciešamo veidni, noklikšķinot uz pogas).
- Jūs apkopojat pārskatu par lapas rekvizītiem, izmantojot tagus, ko norādījāt veidnē.
- Priecājieties: jums ir visa nepieciešamā informācija ērtā formātā.
Slazdiem
Kā kvalitātes inženieris varu droši teikt, ka pasaulē nekas nav ideāls. Pat dievišķie galdi ir nepilnīgi. Un iepriekš minētajā procesā ir nepilnības.
- Ja nolemjat mainīt lapas rekvizītu nosaukumus vai sastāvu, jums būs jāatjaunina visi jau izveidotie objekti, lai to dati būtu pareizi iekļauti kopsavilkuma pārskatā. Tas ir skumji, bet, no otras puses, tas liek detalizēti pārdomāt savas informācijas kopas “arhitektūru”, kas ir ļoti interesants uzdevums.
- Jums būs jāuzraksta pietiekami daudz instrukciju, kā aizpildīt informācijas tabulas un izmantot tagus. Bet, no otras puses, ar šo rakstu jūs varat vienkārši trāpīt visiem pareizajiem cilvēkiem.
Ar produktu nesaistītas dokumentācijas glabāšanas piemērs
Izmantojot iepriekš aprakstīto procesu, jūs varat organizēt gandrīz jebkuras informācijas glabāšanu. Šīs pieejas skaistums ir tāds, ka tā ir universāla: tiklīdz lietotāji pierod pie tās, viņi pārstāj radīt nekārtības. Vēl viens liels (bet ne bezmaksas) pluss ir iespēja lidojumā savākt dažādu statistiku un uz tās pamata uzzīmēt skaistas diagrammas.
Ļaujiet man sniegt piemēru mūsu procesam informācijas uzturēšanai par komandu.
Nolēmām katram kolektīvā izveidot darbinieka karti. Attiecīgi mums ir veidne, pēc kuras katrs jaunais cilvēks izveido sev šo karti un uztur tajā visu personisko informāciju.
Kā redzat, mums ir detalizēta rekvizītu tabula un uzreiz ir norādījumi, kā tieši uzturēt šo lapu. Dažus tagus pēc instrukcijas pievieno paši darbinieki, veidnē ir tikai galvenās: kartes birka darbinieka karte, virziena atzīme virziens-iesaistīt un komandas birka komanda-qa.
Rezultātā pēc tam, kad katrs ir izveidojis sev karti, tiek iegūta pilnīga tabula ar informāciju par darbiniekiem. Šo informāciju var izmantot dažādos punktos. Resursu pārvaldnieki var apkopot sev vispārīgas tabulas, un komandu vadītāji var izveidot komandu tabulas, atlasei pievienojot komandas tagu.
Varat skatīt dažādus kopsavilkumus, piemēram, pēc tagiem qa-upgrade-plan Tiks parādīti visi kvalitātes nodrošināšanas izstrādes uzdevumi. Tajā pašā laikā katrs cilvēks savā darbinieka kartē glabā svarīgu vēsturi un savu attīstības plānu - izveido ligzdotu lapu no attīstības plānu veidnes.
Secinājums
Saglabājiet jebkuru dokumentāciju tā, lai tajā nebūtu kauna, un tas lietotājiem neradītu neciešamas sāpes!
Ļoti ceru, ka raksts būs noderīgs un visa pasaules dokumentācija iestāsies kārtība.
Avots: www.habr.com
