ProjektēŔana Confluence

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.

ProjektēŔana Confluence


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.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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!

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

Ja makro ir paŔpietiekams, tas izskatās kā bloks.

ProjektēŔana Confluence

Ja makro darbībai nepiecieŔams kaut kas, lai to ievietotu, tas izskatās kā rāmis.

ProjektēŔana Confluence

Taču vienā rāmī var ievietot tik daudz citu, kamēr jūsu hierarhijā ir loģika.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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!

ProjektēŔana Confluence

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 ā€žTabulu filtrsā€.

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

ProjektēŔana Confluence

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

ProjektēŔana Confluence

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 ā€žTabulu filtrsā€ , 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.

ProjektēŔana Confluence

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 ā€žKopsavilkuma tabulaā€ 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).

ProjektēŔana Confluence

Dabiski, grupēŔana var notikt pēc vairākiem kritērijiem vienlaikus, visas iespējas var aplÅ«kot dokumentācijā.

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 ā€žDiagramma no tabulasā€. Å ajā makro jāievieto iepriekŔējā punkta kopsavilkuma tabula, un voilĆ  — jÅ«su pelēkie, garlaicÄ«gie dati ir skaisti vizualizēti.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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 atzÄ«mes (pazÄ«stamas visiem sociālajos tÄ«klos kā tagi).

ProjektēŔana Confluence

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

ProjektēŔana Confluence

Lapu īpaŔības

Uz lapu var pievienot vēl vienu interesantu makro, kas palÄ«dz strukturēt informāciju – Ā«Lapu Ä«paŔībasĀ». 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.

ProjektēŔana Confluence

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 Ā«Satura ziņojumsĀ» apkopo visas lapas ar noteiktu atzÄ«mju kopu.

ProjektēŔana Confluence

Tomēr interesantāks ir ziņojums, kas nāk no makro Ā«Lapu Ä«paŔību ziņojumsĀ». 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.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

Tad galīgais process izskatīsies Ŕādi:

  1. Jūs izveidojat veidni konkrēta veida informācijai.
  2. Å ajā veidnē pievienojat etiÄ·etes un lappuses Ä«paŔības makros.
  3. Jebkurā ērtā vietā izveidojiet saknes lapu ar pogu, kuru nospiežot, tiek izveidota apakÅ”lapas no Å”ablona.
  4. 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).
  5. Savāciet sev ziņojumu par lapas Ä«paŔībām, izmantojot etiÄ·etes, kuras esat norādÄ«jis Å”ablonā.
  6. Priecājaties: jums ir visa nepiecieÅ”amā informācija ērtā formātā.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

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.

ProjektēŔana Confluence

Avots: habr.com

Iegādājieties uzticamu tÄ«mekļa hostingu ar DDoS aizsardzÄ«bu, VPS VDS serveriem šŸ”„ Iegādājieties uzticamu tÄ«mekļa hostingu ar DDoS aizsardzÄ«bu, VPS VDS serveriem | ProHoster