Bună ziua tuturor!
Numele meu este Masha, lucrez ca inginer de asigurare a calității în grupul de companii Tinkoff. Lucrarea QA implică multă comunicare cu diferiți oameni din diferite echipe și am fost, de asemenea, manager și lector de programe educaționale, așa că harta mea de comunicare a fost cât mai largă posibil. Și la un moment dat am explodat: mi-am dat seama că nu mai pot, nu pot, nu pot completa tone infernale de tabele și documente imposibil de citit.
Cu siguranță, fiecare dintre voi și-a imaginat acum despre ce vorbesc și a căzut într-o transpirație rece: liste cu nume de familie fără ordine alfabetică, tabele cu sute de coloane cu un aspect neglijent, tabele cu mii de rânduri în care trebuie să ștergeți degetul. pe rotița mouse-ului pentru a căuta titluri, tone de pagini de instrucțiuni nenumerotate, sute de scrisori trimise unul altuia cu date care trebuie analizate și sistematizate și îndesate în aceleași tabele ilizibile.
Și așa, când m-am răcorit puțin, am decis să scriu acest articol. Voi vorbi despre cum puteți menține în mod normal (chiar și uneori convenabil) o varietate de documentație non-produs. Sper că articolul se va împrăștia în rețea și nivelul iadului din departamentele adiacente dezvoltării va scădea măcar puțin, iar oamenii (inclusiv eu) vor deveni puțin mai fericiți.
Instrumente
Documentația produsului este adesea păstrată alături de cod, ceea ce este un lucru bun. Și documentația non-produs este de obicei stocată oriunde. Adesea oamenii încearcă să aducă informații din diferite locuri în Confluence, iar noi nu facem excepție. Deci restul poveștii este despre el.
În general, Confluence este un motor wiki avansat. Vă permite să lucrați cu date în diferite tipuri de afișare: text cu formatare, tabele, diferite diagrame. Acesta este un instrument foarte interesant și puternic, dar dacă nu știți cum să-l gătiți, atunci veți primi un alt depozit de documente care nu pot fi citite. Te voi învăța cum să gătești!
macro-uri
Aproape toată magia Confluence este construită în jurul macro-urilor. Există o mulțime de macrocomenzi și pot fi combinate între ele. Sunt plătite și gratuite, în continuare vor exista diverse exemple de macrocomenzi cu link-uri către documentația pentru ele.
Interfața pentru lucrul cu macrocomenzi este cât se poate de simplă. Pentru a adăuga o macrocomandă, trebuie să faceți clic pe plus și să selectați elementul dorit din listă.
Dacă macro-ul este autosuficient, adică nu necesită inserarea a altceva în interiorul său, arată ca un bloc.
Dacă o macrocomandă are nevoie de ceva în interiorul ei pentru a funcționa, arată ca o cutie.
În același timp, puteți pune câte altele doriți într-un cadru, atâta timp cât există logică în piramida voastră.
Fiecare macrocomandă are o previzualizare: aceasta arată imediat dacă ați completat și configurat corect macrocomanda.
Template-uri
Pe lângă macrocomenzi, există un instrument convenabil pentru pre-completarea conținutului - acesta este un șablon.
Șabloanele pot fi folosite la crearea oricărei pagini: doar faceți clic pe cele trei puncte de lângă butonul „Creați” și selectați șablonul dorit.
Apoi tot conținutul care se află în șablon va fi adăugat la pagina creată.
Oricine poate crea pagini din șabloane, dar numai cei care au dreptul de a crea sau edita șabloane pot crea ei înșiși pagini. Puteți adăuga instrucțiuni suplimentare șablonului despre cum trebuie întreținută pagina.
Magie de masă
De fapt, ca techie, îmi plac foarte mult tabelele și pot include aproape orice informație în ele (deși acest lucru nu este întotdeauna eficient). Tabelele în sine sunt clare, structurate, scalabile, magice!
Dar chiar și o entitate atât de minunată ca o masă poate fi răsfățată. Și poate fi folosit cu succes și chiar îmbunătățit. Mai multe despre asta mai jos.
Filtrare (plugin plătit)
Orice tabel uriaș care nu poate fi citit poate fi făcut puțin mai puțin uriaș și puțin mai lizibil folosind filtrarea. Pentru a face acest lucru, puteți utiliza o macrocomandă plătită .
În interiorul acestei macrocomenzi, trebuie să împingeți o masă (chiar și cea mai urâtă este posibilă, principalul lucru este să o împingeți în întregime). În macrocomandă, puteți selecta coloane pentru filtrul drop-down, filtru text, numeric și filtru de dată.
Imaginați-vă că toate informațiile despre candidații pentru toate posturile vacante sunt înregistrate într-o listă tabelară. Desigur, nesortați - oamenii nu vin la interviuri în ordine alfabetică. Și trebuie să înțelegeți dacă ați intervievat un anumit solicitant înainte. Trebuie doar să puneți acest iad într-o macrocomandă de filtru, să adăugați un filtru de text după nume de familie - și voila, informațiile sunt pe ecran.
Este demn de remarcat faptul că filtrarea tabelelor uriașe poate afecta performanța sistemului și timpul de încărcare a paginii, așa că punerea unui tabel uriaș în filtru este o cârjă temporară, este mai bine să construiți un proces în care oamenii nu trebuie să creeze tabele uriașe care nu pot fi citite (un exemplu de proces va fi la sfârșitul articolului).
Sortare (plugin plătit)
Cu Magic Macro de asemenea, puteți seta sortarea implicită pe orice coloană și puteți numerota rândurile. Sau faceți clic pe orice coloană a tabelului introdusă în macrocomanda de filtru și va avea loc sortarea după această coloană.
De exemplu, aveți același tabel cu aplicanții și trebuie să vă dați seama câte interviuri au fost susținute într-o anumită lună - sortați după dată și bucurați-vă.
Pivot Tables (plugin plătit)
Acum să trecem la un caz mai interesant. Imaginează-ți că masa ta este imensă și trebuie să calculezi ceva pe el. Desigur, îl puteți copia în Excel, calcula de ce aveți nevoie și încărcați datele înapoi în Confluence. Puteți aplica o macrocomandă o dată? și obțineți același rezultat, doar actualizat.
De exemplu: aveți un tabel care conține datele tuturor angajaților - unde sunt localizați geografic și ce posturi ocupă. Pentru a calcula câte persoane sunt în fiecare oraș, trebuie să selectați în macro-ul „Pivot Table” rândul după care sunt agregate datele (locația) și tipul de operațiune (adăugare).
Desigur, puteți grupa după mai multe criterii deodată, puteți vedea toate posibilitățile .
Grafice (plugin plătit)
După cum am spus, nu toată lumea iubește mesele la fel de mult ca mine. Din păcate, majoritatea managerilor nu le plac deloc. Dar toată lumea iubește diagramele de culori strălucitoare.
Creatorii lui Confluence știau cu siguranță acest lucru (cu siguranță au și șefi care iubesc reportajele și topurile, unde ar fi ei fără ele). Prin urmare, puteți utiliza macro-ul magic . În această macrocomandă, trebuie să puneți tabelul pivot din paragraful anterior și voila - datele voastre gri plictisitoare sunt vizualizate frumos.
Desigur, această macrocomandă are și setări. Un link către documentația pentru orice macrocomandă poate fi găsit în modul de editare al acelei macrocomenzi.
Ușurință de agregare
Informațiile din paragrafele anterioare probabil că nu au fost o revelație pentru tine. Dar acum știi cu siguranță cum să folosești macrocomenzi și pot trece la partea mai interesantă a articolului.
Tag-uri
Este rău când oamenii stochează informații într-un articol nestructurat sau într-un tabel imens. Și mai rău este atunci când părți din aceste informații nu sunt doar ilizibile, ci și împrăștiate pe întinderile Confluenței. Din fericire, este posibil să colectați informații împrăștiate într-un singur loc. Pentru aceasta trebuie să utilizați (etichete familiare tuturor de pe rețelele sociale).
Orice număr de etichete poate fi adăugat la orice pagină. Făcând clic pe o etichetă, veți ajunge la o pagină de agregare cu link-uri către tot conținutul cu acea etichetă, precum și un set de etichete asociate. Etichetele înrudite sunt cele care apar frecvent pe aceeași pagină.
Proprietățile paginii
Puteți adăuga o altă macrocomandă interesantă pe pagină pentru structurarea informațiilor - . În interiorul acestuia, trebuie să trimiteți un tabel cu două coloane, prima va fi cheia, iar a doua va fi valoarea proprietății. Mai mult, macro-ul poate fi ascuns din pagină, astfel încât să nu interfereze cu citirea conținutului, dar pagina va fi în continuare marcată cu cheile necesare.
Acordați atenție ID-ului - este convenabil să îl setați să atârne diferite grupuri de proprietăți pe pagini diferite (sau chiar diferite grupuri de proprietăți pe o singură pagină).
rapoarte
Prin etichete, puteți colecta rapoarte. De exemplu, macro colectează toate paginile cu un anumit set de etichete.
Dar un raport mai interesant este un macro . De asemenea, colectează toate paginile cu un anumit set de etichete, dar nu doar le enumeră, ci alcătuiește un tabel (prinzi legătura cu începutul articolului?), în care coloanele sunt cheile proprietăților paginii.
Rezultă un tabel rezumat de informații din diferite surse. E bine că are caracteristici convenabile: aspect adaptiv, sortare după orice coloană. De asemenea, un astfel de tabel de raportare poate fi configurat în interiorul macrocomenzii.
La configurare, puteți elimina unele coloane din raport, puteți seta starea implicită sau numărul de înregistrări afișate. De asemenea, puteți seta ID-ul proprietății paginii pentru a vedea numai informațiile de care aveți nevoie.
De exemplu, ai o mulțime de pagini de angajați, aceste pagini au un set de proprietăți despre o persoană: la ce nivel este, unde se află, când s-a alăturat echipei și așa mai departe. Aceste proprietăți sunt marcate id = employee_inf. Și există un al doilea set de proprietăți pe aceeași pagină, care conține informații despre o persoană ca parte a unei echipe: ce rol îndeplinește persoana, în ce echipă se află și așa mai departe. Aceste proprietăți sunt marcate ID = team_inf. Apoi, atunci când compilați un raport, puteți afișa numai informații pentru un ID sau două deodată - oricare dintre acestea este mai convenabil.
Frumusețea acestei abordări este că fiecare poate colecta tabelul de informații de care are nevoie, care nu va duplica nimic și va fi actualizat când pagina principală este actualizată. De exemplu: unui lider de echipă nu îi pasă când dezvoltatorii lui au primit un loc de muncă, dar este important ce rol joacă fiecare dintre ei în echipă. Liderul echipei va colecta un raport despre echipă. Și contabilului nu îi pasă cine îndeplinește ce rol, dar pozițiile sunt importante - va colecta un raport cu privire la poziții. În acest caz, sursa de informații nu va fi duplicată sau transferată.
Procesul final
Instrucție
Deci, putem structura frumos și agrega informațiile în mod eficient în Confluence folosind macrocomenzi ca exemplu. Dar, în mod ideal, trebuie să vă asigurați că informațiile noi sunt imediat structurate și intră în toate mecanismele de agregare deja utilizate.
Aici o grămadă de macrocomenzi și șabloane vor veni în ajutor. Pentru a determina oamenii să creeze pagini noi în formatul potrivit, puteți utiliza macrocomandă Creare din șablon. Se adaugă un buton la pagină, făcând clic pe care se creează o pagină nouă din șablonul de care aveți nevoie. Astfel, îi faci pe oameni să lucreze imediat în formatul de care ai nevoie.
În șablonul din care permiteți crearea unei pagini, trebuie să adăugați etichete, macro-ul „Proprietăți pagini” și un tabel cu proprietățile de care aveți nevoie în prealabil. De asemenea, recomand să adăugați instrucțiuni despre valorile cu care să umpleți pagina și valorile proprietăților.
Apoi procesul final va arăta astfel:
- Creați un șablon pentru un anumit tip de informații.
- În acest șablon, adăugați etichete și proprietăți de pagină într-o macrocomandă.
- În orice loc convenabil, creați o pagină rădăcină cu un buton, făcând clic pe care este creată o pagină copil din șablon.
- Porniți pe pagina rădăcină a utilizatorilor care pot genera informațiile necesare (conform șablonului dorit, făcând clic pe butonul).
- Colectați-vă un raport despre proprietățile paginii prin etichetele pe care le-ați specificat în șablon.
- Bucură-te: ai toate informațiile de care ai nevoie într-un format convenabil.
Capcane
Ca inginer de calitate, pot spune cu siguranță că nu există nimic perfect în lume. Chiar și mesele divine sunt imperfecte. Și există capcane în procesul de mai sus.
- Dacă decideți să modificați numele sau compoziția proprietăților paginii, va trebui să actualizați toate obiectele deja create, astfel încât datele lor să fie corect introduse în raportul de rezumat. Este trist, dar pe de altă parte, te obligă să te gândești în detaliu la „arhitectura” setului tău de informații, ceea ce este o sarcină foarte interesantă.
- Va trebui să scrieți o cantitate decentă de instrucțiuni despre cum să completați tabelele cu informații și să utilizați etichetele. Dar, pe de altă parte, poți doar să arunci acest articol tuturor persoanelor potrivite.
Un exemplu de stocare a documentației non-produs
Prin procesul descris mai sus, puteți organiza stocarea aproape oricărei informații. Frumusețea abordării este că este universală: odată ce utilizatorii se obișnuiesc cu ea, nu mai fac mizerie. De asemenea, un mare plus (dar nu gratuit) este capacitatea de a colecta diverse statistici din mers și de a desena diagrame frumoase pe el.
Voi da un exemplu al procesului nostru de păstrare a informațiilor despre echipă.
Pentru fiecare persoană din echipă am decis să creăm un card de angajat. În consecință, avem un șablon conform căruia fiecare persoană nouă își creează acest card pentru sine și își păstrează toate informațiile personale în el.
După cum puteți vedea, avem un tabel detaliat cu proprietăți și imediat avem instrucțiuni despre cum să întreținem această pagină. Unele dintre etichete sunt puse de către angajați înșiși conform instrucțiunilor, în șablon doar cele principale: eticheta cardului card-angajat, etichetă de direcție direcție-implica și eticheta de comandă echipa-qa.
Ca urmare, după ce fiecare și-a creat un card pentru sine, se obține un tabel complet cu informații despre angajați. Aceste informații pot fi utilizate în diferite puncte. Managerii de resurse pot colecta tabele generale pentru ei înșiși, iar liderii de echipă pot colecta tabele de comandă adăugând o etichetă de echipă la selecție.
După etichete, puteți vedea diferite rezumate, de exemplu, după qa-plan-upgrade vor fi afișate toate sarcinile pentru dezvoltarea QA. În același timp, fiecare persoană din cardul său de angajat păstrează o poveste importantă și propriul plan de dezvoltare - creează o pagină imbricată din șablonul planurilor de dezvoltare.
Concluzie
Păstrați orice documentație în așa fel încât să nu vă fie rușine de ea, iar utilizatorii să nu fie răniți în mod chinuitor!
Sper din tot sufletul ca articolul sa fie de folos si ordinea sa vina in toata documentatia lumii.
Sursa: www.habr.com