Dizains saplūŔanā

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.

Dizains saplūŔanā


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.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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!

Dizains saplūŔanā

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.

Dizains saplūŔanā

Ja makro ir autonoms, tas ir, tajā nav jāievieto nekas cits, tas izskatās kā bloks.

Dizains saplūŔanā

Ja makro ir nepiecieŔams kaut kas tajā ievietots, lai tas darbotos, tas izskatās kā rāmis.

Dizains saplūŔanā

Tajā paŔā laikā vienā kadrā varat ievietot tik daudz citu, cik vēlaties, ja vien jÅ«su piramÄ«dā ir loÄ£ika.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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!

Dizains saplūŔanā

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 "Tabulas filtrs".

Å 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.

Dizains saplūŔanā

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ā.

Dizains saplūŔanā

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 "Tabulas filtrs" 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.

Dizains saplūŔanā

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? "Rakurstabula" 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).

Dizains saplūŔanā

Dabiski, ka var grupēt pēc vairākiem kritērijiem uzreiz, visas iespējas var apskatīt dokumentācijā.

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 "Diagramma no tabulas". Å ajā makro ir jāievieto rakurstabula no iepriekŔējās rindkopas, un voila - jÅ«su pelēkie garlaicÄ«gie dati ir lieliski vizualizēti.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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 tagus (atzÄ«mes, kas visiem pazÄ«stamas no sociālajiem tÄ«kliem).

Dizains saplūŔanā

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ā.

Dizains saplūŔanā

Lapas rekvizīti

Lai strukturētu informāciju, lapai varat pievienot vēl vienu interesantu makro - "Lapas rekvizÄ«ti". 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.

Dizains saplūŔanā

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 "Satura pārskats" apkopo visas lapas ar noteiktu tagu kopu.

Dizains saplūŔanā

Bet interesantāks ziņojums ir makro "Lapas rekvizÄ«tu pārskats". 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.

Dizains saplūŔanā

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ē.

Dizains saplūŔanā

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ā.

Dizains saplūŔanā

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.

Dizains saplūŔanā

Tad pēdējais process izskatÄ«sies Ŕādi:

  1. Jūs izveidojat veidni noteikta veida informācijai.
  2. Šajā veidnē makro pievienojat iezīmes un lapas rekvizītus.
  3. Jebkurā ērtā vietā izveidojiet saknes lapu ar pogu, uz kuras noklikŔķinot, no veidnes tiek izveidota bērna lapa.
  4. 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).
  5. Jūs apkopojat pārskatu par lapas rekvizītiem, izmantojot tagus, ko norādījāt veidnē.
  6. Priecājieties: jums ir visa nepiecieÅ”amā informācija ērtā formātā.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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.

Dizains saplūŔanā

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.

Dizains saplūŔanā

Avots: www.habr.com

Pievieno komentāru