Дизајн у Цонфлуенце

Поздрав свима!

Моје име је Маша, радим као инжењер за обезбеђење квалитета у групи компанија Тинкофф. КА посао подразумева доста комуникације са различитим људима из различитих тимова, а био сам и менаџер и предавач едукативних програма, тако да је моја комуникациона мапа била што шира. И у неком тренутку сам експлодирао: схватио сам да не могу, не могу, не могу да попуним паклене тоне нечитљивих табела и докумената.

Сигурно је свако од вас сада замислио о чему причам и облио га хладан зној: спискови презимена без азбучног реда, табеле са стотинама колона кривог распореда, табеле са хиљадама редова у којима треба да обришете прст. на точкић миша да се погледа заглавље, тоне страница ненумерираних упутстава, стотине писама послатих једно другом са подацима које треба анализирати и систематизовати и стрпати у једнако нечитљиве табеле.

И тако, када сам се мало охладио, одлучио сам да напишем овај чланак. Говорићу о томе како можете нормално (чак понекад и згодно) да одржавате разноврсну документацију која није производ. Надам се да ће се чланак проширити интернетом и да ће се ниво пакла у одељењима у близини развоја барем мало смањити, а људи (укључујући и мене) ће постати мало срећнији.

Алат

Документација о производу се често држи поред кода, што је добра ствар. А документација која није у вези са производом се обично чува било где. Људи често покушавају да пренесу информације са различитих места у Цонфлуенце, и ми нисмо изузетак. Дакле, остатак приче је о њему.

Генерално, Цонфлуенце је напредна вики машина. Омогућава вам да радите са подацима у различитим типовима приказа: текст са форматирањем, табеле, разни графикони. Ово је веома интересантан и моћан алат, али ако не знате како да га припремите, онда ћете на крају добити још једну депонију нечитљивих докумената. Научићу те како да куваш!

макрои

Скоро сва магија Цонфлуенце долази од макроа. Постоји много макроа и могу се комбиновати једни са другима. Могу бити плаћени или бесплатни; у наставку ће бити разни примери макроа са везама до документације за њих.

Интерфејс за рад са макроима је што једноставнији. Да бисте додали макро, потребно је да кликнете на плус и изаберете жељени елемент са листе.

Ако је макро самосталан, односно не захтева уметање било чега другог у себе, он изгледа као блок.

Ако макро захтева да се нешто стави у њега да би функционисао, он изгледа као оквир.

Истовремено, у један оквир можете поставити колико год желите, све док у вашој пирамиди постоји логика.

Сваки макро има преглед: одмах показује да ли сте исправно попунили и конфигурисали макро.

шаблони

Поред макроа, постоји и згодан алат за претходно попуњавање садржаја - шаблон.
Шаблони се могу користити приликом креирања било које странице: само кликните на три тачке поред дугмета „Креирај“ и изаберите жељени шаблон.

Тада ће сав садржај који се налази у шаблону бити додат на креирану страницу.

Свако може да креира странице од шаблона, али само они који имају права да сами креирају или уређују шаблоне то могу да раде. Можете додати додатна упутства шаблону о томе како страницу треба одржавати.

Магија столова

У ствари, као техничар, јако волим столове и могу да умотам скоро све информације у њих (иако то није увек ефикасно). Саме табеле су јасне, структуриране, скалабилне, магичне!

Али чак и тако диван ентитет као сто је сто може бити уништен. И можете га успешно користити, па чак и побољшати. Више о овоме у наставку.

Филтрирање (плаћени додатак)

Било која огромна, нечитљива табела може се учинити мало мање огромном и мало читљивом коришћењем филтрирања. За ово можете користити плаћени макро „Филтер табеле“.

Унутар овог макроа морате ставити табелу (чак је и најружнији могући, главна ствар је да га гурнете у целини). У макроу можете да изаберете колоне за падајући филтер, текстуални филтер, нумерички филтер и филтер датума.

Замислите само да се све информације о кандидатима за сва слободна радна места евидентирају у табели. Наравно, неразврстано - људи долазе на интервјуе не по абецедном реду. И морате да разумете да ли сте раније интервјуисали одређеног кандидата. Само треба да ставите овај пакао у макро филтера, додате филтер текста по презимену - и воила, информације су на вашем екрану.

Вреди напоменути да филтрирање огромних табела може утицати на перформансе система и време учитавања страница, тако да је стављање огромне табеле у филтер привремена штака; боље је изградити процес у којем људи не морају да креирају огромне, нечитљиве табеле ( пример процеса биће на крају чланка).

Сортирање (плаћени додатак)

Коришћење магичног макроа „Филтер табеле“ Такође можете поставити подразумевано сортирање било које колоне и нумерисати редове. Или кликните на било коју колону табеле уметнуту у макро филтера и сортирање ће се извршити по тој колони.

На пример, имате исту табелу са кандидатима и треба да процените колико је интервјуа обављено у одређеном месецу - сортирајте по датуму и будите срећни.

Пивот табеле (плаћени додатак)

Сада пређимо на занимљивији случај. Замислите да је ваша табела огромна и да из ње треба нешто да израчунате. Наравно, можете га копирати у Екцел, израчунати шта вам је потребно и отпремити податке назад у Цонфлуенце. Можете ли једном да користите макро? "Ротациона табела" и добити исти резултат, само ажуриран.

На пример: имате табелу која прикупља податке о свим запосленима – где се географски налазе и које позиције имају. Да бисте израчунали колико људи има у сваком граду, потребно је да изаберете ред у макроу заокретне табеле који обједињује податке (локацију) и тип операције (додавање).

Наравно, можете груписати по неколико критеријума одједном, све могућности се могу видети у документацији.

Графикони (плаћени додатак)

Као што сам рекао, не воле сви столове колико ја. Нажалост, већина менаџера их уопште не воли. Али сви заиста воле дијаграме светлих боја.
Креатори Цонфлуенце-а су сигурно знали за ово (вероватно имају и шефове који воле извештаје и дијаграме, где би без тога). Стога можете користити магични макро „Графикон из табеле“. У овај макро треба да ставите стожерну табелу из претходног пасуса, и воила – ваши сиви досадни подаци су лепо визуализовани.

Наравно, овај макро такође има подешавања. Веза до документације за било који макро се може наћи у режиму за уређивање тог макроа.

Лако агрегирање

Информација из претходних пасуса вероватно није била откровење за вас. Али сада дефинитивно знате како да користите макрое, а ја могу да пређем на занимљивији део чланка.

Етикете

Лоше је када људи чувају информације у једном неструктурираном чланку или огромној табели. Још је горе када делови ових информација нису само нечитљиво форматирани, већ и разбацани по целом Цонфлуенцеу. На срећу, могуће је прикупити разбацане информације на једном месту. Да бисте то урадили, морате користити етикете (ознаке свима познате са друштвених мрежа).

Можете додати било који број ознака на било коју страницу. Кликом на ознаку одвешћете вас на страницу за прикупљање података са везама ка свим садржајима са том ознаком, као и скупом повезаних ознака. Повезане ознаке су оне које се често појављују на истој страници.

Својства странице

Можете додати још један интересантан макро на страницу да структурирате информације - „Својства странице“. Унутар њега треба да доставите табелу од две колоне, прва ће бити кључ, а друга вредност својства. Штавише, макро се може сакрити са странице тако да не омета читање садржаја, али ће страница и даље бити означена потребним кључевима.

Обратите пажњу на ИД – згодно је подесити га да додели различите групе својстава различитим страницама (или чак различите групе својстава једној страници).

Извештаји

Можете прикупљати извештаје помоћу ознака. На пример, макро „Извештај о садржају“ прикупља све странице са одређеним скупом ознака.

Али занимљивији извештај је макро „Извештај о својствима странице“. Такође прикупља све странице са одређеним скупом ознака, али не приказује само њихову листу, већ прави табелу (хватате ли везу са почетком чланка?), у којој су колоне страница кључеви имовине.

Резултат је збирна табела информација из различитих извора. Лепо је што има згодне функције: прилагодљиви распоред, сортирање по било којој колони. Такође, таква табела за извештавање може да се конфигурише унутар макроа.

Када конфигуришете, можете уклонити неке колоне из извештаја, поставити подразумевано стање или број приказаних записа. Такође можете да подесите ИД својства странице да видите само информације које су вам потребне.

На пример, имате много страница о запосленима, ове странице имају скуп својстава о особи: који је ниво, где се налази, када се придружио тиму итд. Ова својства су означена ИД = запослене_инф. И постоји други скуп својстава на истој страници, који садржи информације о особи као делу тима: коју улогу особа игра, у ком је тиму и тако даље. Ова својства су означена ИД = теам_инф. Затим, приликом састављања извештаја, можете истовремено приказати само информације за један или два ИД – шта год је згодније.

Лепота овог приступа је у томе што свако може да састави табелу са информацијама која му је потребна, која ништа неће дуплирати и биће ажурирана када се главна страница ажурира. На пример: вођи тима није важно када су његови програмери добили посао, већ је важно коју улогу сваки од њих игра у тиму. Вођа тима ће прикупити извештај о тиму. А рачуновођа углавном не мари ко обавља коју улогу, али позиције су важне - он ће саставити извештај о позицијама. У овом случају, извор информација неће бити дуплиран или пренет.

Завршни процес

Инструкција

Дакле, можемо лепо структурирати и ефикасно агрегирати информације у Цонфлуенце користећи макрое као пример. Али идеално би било да се уверите да су нове информације одмах структурисане и да спадају у све механизме агрегације који се већ користе.

Овде ће гомила макроа и шаблона доћи у помоћ. Да бисте натерали људе да креирају нове странице у жељеном формату, можете користити макро Креирај из шаблона. Додаје дугме на страницу, када се кликне, креира се нова страница од шаблона који вам је потребан. На овај начин присиљавате људе да одмах раде у формату који вам је потребан.

У шаблон из којег креирате страницу, потребно је да додате ознаке, макро „Својства странице“ и табелу са својствима која су вам потребна унапред. Такође препоручујем да додате упутства о томе које вредности треба попунити на страници и вредности својстава.

Тада ће коначни процес изгледати овако:

1. Правите шаблон за одређену врсту информација.
2. У овом шаблону додајете ознаке и својства странице у макро.
3. На било ком погодном месту креирајте основну страницу помоћу дугмета, кликом на које креирате подређену страницу из шаблона.
4. Пустите кориснике да оду на основну страницу, који ће потенцијално генерисати потребне информације (према траженом шаблону, кликом на дугме).
5. Сакупљате извештај о својствима странице помоћу ознака које сте навели у шаблону.
6. Радујте се: имате све потребне информације у погодном формату.

Замке

Као инжењер квалитета, могу слободно да кажем да ништа није савршено на свету. Чак су и божанске трпезе несавршене. И постоје замке у горе наведеном процесу.

• Ако одлучите да промените називе или састав својстава странице, мораћете да ажурирате све већ креиране објекте тако да њихови подаци буду исправно укључени у збирни извештај. Ово је тужно, али вас, с друге стране, тера да детаљно размислите о „архитектури“ вашег скупа информација, што је веома интересантан задатак.
• Мораћете да напишете доста инструкција о томе како да попуните табеле са информацијама и користите ознаке. Али с друге стране, овим чланком можете погодити све праве људе.

Пример чувања документације која се не односи на производ

Кроз горе описани процес, можете организовати складиштење готово свих информација. Лепота приступа је у томе што је универзалан: када се корисници навикну на њега, престају да стварају неред. Још један велики (али не и бесплатан) плус је могућност прикупљања разних статистика у лету и цртања прелепих дијаграма на основу њих.

Дозволите ми да вам дам пример нашег процеса за одржавање информација о тиму.

Одлучили смо да направимо картицу запосленог за сваку особу у тиму. Сходно томе, имамо шаблон према којем свака нова особа креира ову картицу за себе и у њој одржава све личне податке.

Као што видите, имамо детаљну табелу својстава и одмах имамо упутства о томе како тачно да одржавамо ову страницу. Неке од ознака додају сами запослени према упутствима, а шаблон садржи само главне: ознаку картице запослени-картица, ознака правца правац-укључити и ознака тима тим-ка.

Као резултат, након што свако креира картицу за себе, добија се комплетна табела са подацима о запосленима. Ове информације се могу користити на различитим местима. Менаџери ресурса могу да прикупљају опште табеле за себе, а вође тима могу да креирају тимске табеле додавањем ознаке тима избору.

На пример, можете видети различите резимее по ознакама ка-упграде-план Сви КА развојни задаци ће бити приказани. Истовремено, свака особа чува важну историју и сопствени развојни план у својој картици запосленог – креира угнежђену страницу од шаблона развојних планова.

Закључак

Сваку документацију чувајте на начин да у њој нема срамоте и да не задаје несвакидашњи бол корисницима!

Заиста се надам да ће чланак бити користан и да ће доћи ред у сву документацију на свету.

Извор: ввв.хабр.цом