Дизајн во сливот

Здраво на сите!

Јас се викам Маша, работам како инженер за обезбедување квалитет во групацијата на компании Тинкоф. Работата за ОК вклучува многу комуникација со различни луѓе од различни тимови, а јас бев и менаџер и предавач на образовни програми, така што мојата комуникациска карта беше што поширока. И во одреден момент експлодирав: сфатив дека веќе не можам, не можам, не можам да пополнам пеколни тони нечитливи табели и документи.

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

И така, кога малку се оладив, решив да ја напишам оваа статија. Ќе зборувам за тоа како можете нормално (дури и понекогаш погодно) да одржувате разновидна документација што не е производ. Се надевам дека статијата ќе се распрсне низ мрежата и нивото на пеколот во одделенијата во непосредна близина на развојот ќе се намали барем малку, а луѓето (вклучувајќи ме и мене) ќе станат малку посреќни.

Алатки

Документацијата за производот често се чува покрај кодот, што е добра работа. И документацијата што не е производ обично се чува насекаде. Често луѓето се обидуваат да внесат информации од различни места во Confluence, а ние не сме исклучок. Значи, остатокот од приказната е за него.

Општо земено, Confluence е напреден вики-мотор. Ви овозможува да работите со податоци во различни типови на приказ: текст со форматирање, табели, разни графикони. Ова е многу интересна и моќна алатка, но ако не знаете како да ја готвите, тогаш ќе добиете уште една депонија нечитливи документи. Јас ќе те научам како да готвиш!

макроа

Речиси целата магија на Confluence е изградена околу макроата. Има многу макроа, и тие можат да се комбинираат едни со други. Тие се платени и бесплатни, понатаму ќе има различни примери на макроа со линкови до документација за нив.

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

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

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

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

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

шаблони

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

Потоа целата содржина што е во шаблонот ќе биде додадена на креираната страница.

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

Магија на маса

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

Но, дури и таков прекрасен ентитет како маса може да се расипе. И може успешно да се користи, па дури и да се подобри. Повеќе за тоа подолу.

Филтрирање (платен приклучок)

Секоја огромна нечитлива табела може да се направи малку помалку огромна и малку почитлива користејќи филтрирање. За да го направите ова, можете да користите платено макро Филтер за табела.

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

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

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

Подредување (платен приклучок)

Со магично макро Филтер за табела исто така можете да го поставите стандардното сортирање на која било колона и да ги нумерирате редовите. Или кликнете на која било колона од табелата ставена во макрото за филтрирање и ќе се појави сортирање по оваа колона.

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

Стожерни табели (платен приклучок)

Сега да преминеме на поинтересен случај. Замислете дека вашата маса е огромна и треба да пресметате нешто на неа. Се разбира, можете да го копирате во Excel, да пресметате што ви треба и да ги испратите податоците назад во Confluence. Можете ли да примените макро еднаш? „Табела на вртење“ и добијте го истиот резултат, само ажуриран.

На пример: имате табела која ги содржи податоците за сите вработени - каде се географски лоцирани и какви позиции имаат. За да пресметате колку луѓе има во секој град, треба да го изберете во макрото „Pivot Table“ редот според кој се собираат податоците (локација) и видот на операцијата (додавање).

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

Табели (платен приклучок)

Како што реков, не сите ги сакаат масите како мене. За жал, повеќето менаџери воопшто не ги сакаат. Но, секој сака табели со светли бои.
Креаторите на Confluence сигурно знаеле за ова (сигурно имаат и шефови кои сакаат извештаи и графикони, каде би биле без тоа). Затоа, можете да го користите магичното макро „Табела од табелата“. Во ова макро, треба да ја ставите стожерната табела од претходниот пасус, и voila - вашите здодевни сиви податоци се прекрасно визуелизирани.

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

Леснотија на агрегација

Информациите од претходните параграфи веројатно не беа откровение за вас. Но, сега дефинитивно знаете како да користите макроа и можам да преминам на поинтересниот дел од статијата.

Тагови

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

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

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

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

Обрнете внимание на ID - погодно е да го поставите да виси различни групи својства на различни страници (или дури и различни групи својства на една страница).

извештаи

По ознаки, можете да собирате извештаи. На пример, макро Извештај за содржина ги собира сите страници со одреден сет на ознаки.

Но, поинтересен извештај е макро Извештај за својствата на страницата. Исто така, ги собира сите страници со одреден сет на ознаки, но не само што ги наведува, туку составува табела (дали ја фаќате врската со почетокот на статијата?), во која колоните се клучеви на својствата на страницата.

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

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

На пример, имате многу страници за вработени, овие страници имаат збир на својства за некоја личност: на кое ниво е, каде е, кога се приклучил на тимот итн. Овие својства се означени id = вработен_инф. И постои втор сет на својства на истата страница, кој содржи информации за личност како дел од тимот: каква улога извршува лицето, во кој тим е и така натаму. Овие својства се означени ID = тим_инф. Потоа, кога составувате извештај, можете да прикажете само информации за една или две лични карти одеднаш - што е поудобно.

Убавината на овој пристап е што секој може да ја собере потребната табела со информации, која нема да дуплира ништо и ќе се ажурира кога ќе се ажурира главната страница. На пример: на лидерот на тимот не му е грижа кога неговите програмери добиле работа, туку важно е каква улога има секој од нив во тимот. Водачот на тимот ќе собере извештај за тимот. И на сметководителот не му е грижа кој каква улога ќе има, но позициите се важни - тој ќе собере извештај за позициите. Во овој случај, изворот на информации нема да се дуплира или пренесе.

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

Настава

Значи, можеме убаво да ги структурираме и ефективно да ги собираме информациите во Confluence користејќи макроа како пример. Но, идеално, треба да бидете сигурни дека новите информации веднаш се структурирани и влегуваат во сите механизми за собирање што веќе се користат.

Еве еден куп макроа и шаблони ќе дојдат на помош. За да ги натерате луѓето да креираат нови страници во вистинскиот формат, можете да го користите макрото Креирај од Шаблон. Додава копче на страницата, со кликнување на кое се креира нова страница од шаблонот што ви треба. На овој начин ги терате луѓето веднаш да работат во форматот што ви треба.

Во шаблонот од кој дозволувате да креирате страница, треба однапред да додадете етикети, макрото „Карактеристики на страницата“ и табела со својствата што ви се потребни. Исто така, препорачувам да додадете упатства за тоа со кои вредности да се пополни страницата и вредностите на имотот.

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

1. Креирате образец за одреден тип на информации.
2. Во овој шаблон, додајте етикети и својства на страницата во макро.
3. На кое било погодно место, креирајте root страница со копче, со кликнување на кое се креира детска страница од шаблонот.
4. Стартувајте се на root страницата на корисници кои потенцијално ќе ги генерираат потребните информации (според саканиот шаблон, со кликнување на копчето).
5. Соберете си извештај за својствата на страницата преку ознаките што сте ги навеле во шаблонот.
6. Радувај се: ги имаш сите потребни информации во пригоден формат.

Стапици

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

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

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

Преку процесот опишан погоре, можете да организирате складирање на речиси сите информации. Убавината на пристапот е што тој е универзален: штом корисниците ќе се навикнат на него, тие престануваат да прават хаос. Исто така, голем (но не и бесплатен) плус е можноста да се собираат разни статистички податоци во лет и да се цртаат прекрасни дијаграми на неа.

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

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

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

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

По ознаки, можете да видите различни резимеа, на пример, од qa-надградба-план ќе се прикажат сите задачи за развој на QA. Во исто време, секој човек во својата картичка за вработени чува важна приказна и свој план за развој - тој создава вгнездена страница од шаблонот за развојни планови.

Заклучок

Чувајте ја секоја документација на таков начин да не се срамите од неа, а корисниците да не бидат мачно повредени!

Навистина се надевам дека статијата ќе биде корисна и ќе дојде ред во целата светска документација.

Извор: www.habr.com