Bonghjornu ognunu!
Mi chjamu Masha, travagliu cum'è ingegnere di assicurazione di qualità in u gruppu di cumpagnie Tinkoff. U travagliu di QA implica assai cumunicazioni cù diverse persone di diverse squadre, è era ancu un manager è un lecturer di prugrammi educativi, cusì a mo mappa di cumunicazione era u più larga pussibule. È à un certu puntu aghju splosu: aghju realizatu chì ùn possu più, ùn possu micca, ùn possu micca cumpiendu tunnellate infernali di tavule è documenti illeggibili.
Di sicuru, ognunu di voi hà avà imaginatu ciò chì parlu, è s'hè lampatu in un sudore friddu: listi di cognomi senza ordine alfabeticu, tavule cù centinaie di culonne cù un layout sloppy, tavule cù millaie di linii in quale avete bisognu di sguassà u dito. nantu à a rota di u mouse per circà l'intestazione, tunnellate di pagine di struzzioni senza numerazione, centinaie di lettere mandate à l'altri cù dati chì anu da esse analizati è sistematizzati è imbottiti in i listessi tabelle illeggibili.
È cusì, quandu aghju rinfriscatu un pocu, decisu di scrive stu articulu. Parlaraghju di cumu si pò nurmalmente (ancu qualchì volta convenientemente) mantene una varietà di documentazione non-prodottu. Spergu chì l'articulu si sparghje nantu à a reta è u livellu di l'infernu in i dipartimenti adiacenti à u sviluppu abbandunà almenu un pocu, è a ghjente (cumpresu mè) diventeranu un pocu più felice.
Ferramenti
A documentazione di u produttu hè spessu guardata cù u codice, chì hè una bona cosa. È a documentazione non-prodottu hè generalmente guardata in ogni locu. Spessu a ghjente prova à purtà infurmazioni da diversi lochi in Confluence, è ùn simu micca eccezzioni. Allora u restu di a storia hè nantu à ellu.
In generale, Confluence hè un mutore wiki avanzatu. Permette di travaglià cù dati in diversi tipi di visualizazione: testu cù formatting, tavule, diversi charts. Questu hè un strumentu assai interessante è putente, ma s'ellu ùn sapete micca a cucina, allora vi uttene un altru dump di documenti illegibili. Vi insegneraghju a cucina !
macros
Quasi tutta a magia di Confluence hè custruita intornu à macros. Ci sò assai macros, è ponu esse cumminati cù l'altri. Sò pagati è gratuiti, in più ci saranu diversi esempi di macros cù ligami à a documentazione per elli.
L'interfaccia per travaglià cù macros hè simplice quant'è pussibule. Per aghjunghje una macro, avete bisognu di cliccà nantu à u plus è selezziunate l'elementu desideratu da a lista.
Se a macro hè autosufficiente, vale à dì, ùn hè micca bisognu di l'inserzione di qualcosa in sè stessu, pare un bloccu.
Se una macro hà bisognu di qualcosa dentru per travaglià, s'assumiglia à una scatula.
À u listessu tempu, pudete mette quant'è altri quant'è vo vulete in un quadru, sempre chì ci hè logica in a vostra piramide.
Ogni macro hà una vista previa: mostra immediatamente s'ellu avete cumpletu è cunfiguratu a macro currettamente.
Modelli
In più di i macros, ci hè un strumentu convenientu per u cuntenutu pre-filling - questu hè un mudellu.
I mudelli ponu esse utilizati quandu creanu qualsiasi pagina: basta à cliccà nantu à i trè punti accantu à u buttone "Crea" è selezziunate u mudellu desideratu.
Allora tuttu u cuntenutu chì hè in u mudellu serà aghjuntu à a pagina creata.
Qualchese pò creà pagine da mudelli, ma solu quelli chì anu u dirittu di creà o edità mudelli stessi ponu creà pagine. Pudete aghjunghje struzzioni supplementari à u mudellu nantu à cumu si deve mantene a pagina.
Table Magic
In verità, cum'è un tecnicu, mi piace assai e tavule è ponu impannillamentu quasi ogni infurmazione in elli (ancu se questu ùn hè micca sempre efficace). I tavulini stessi sò chjaru, strutturati, scalabili, magichi!
Ma ancu una entità cusì maravigliosa cum'è una tavola pò esse spoiled. È pò esse usatu bè è ancu migliuratu. Più nantu à quì sottu.
Filtrazione (plugin pagatu)
Ogni tavula grande illeggibile pò esse fatta un pocu menu enormi è un pocu più leghjite cù filtrazione. Per fà questu, pudete aduprà una macro pagata .
Dintra sta macro, avete bisognu di scaccià una tavola (ancu u più bruttu hè pussibule, a cosa principal hè di scaccià sanu). In a macro, pudete selezziunà e colonne per u filtru drop-down, u filtru di testu, u filtru numericu è di data.
Immaginate chì tutte l'infurmazioni nantu à i candidati per tutti i vacanti sò registrati in una lista tabulare. Naturalmente, senza sorte - a ghjente ùn vene micca à l'entrevista in ordine alfabeticu. È avete bisognu di capisce s'ellu avete intervistatu un candidatu specificu prima. Basta à mette stu infernu in una macro di filtru, aghjunghje un filtru di testu da u cognome - è voilà, l'infurmazioni sò nantu à a vostra pantalla.
Vale a pena nutà chì a filtrazione di tavule enormi pò influenzà u rendiment di u sistema è u tempu di carica di a pagina, cusì mette una tavula enormosa in u filtru hè una crutch temporaria, hè megliu custruisce un prucessu in quale a ghjente ùn deve micca creà tavule enormi illeggibili (un esempiu di u prucessu serà à a fine di l'articulu).
Sorting (plugin pagatu)
Cù Magic Macro Pudete ancu stabilisce l'ordinamentu predeterminatu in ogni colonna è numerate e fila. O cliccate nant'à ogni culonna di a tavula messa in a macro di filtru, è a classificazione per questa colonna si farà.
Per esempiu, avete a listessa tavula cù i candidati è avete bisognu di sapè quante entrevista sò state tenute in un certu mese - sorte per data è rallegrate.
Pivot Tables (plugin pagatu)
Avà andemu à un casu più interessante. Imagine chì a vostra tavola hè enormosa è avete bisognu di calculà qualcosa nantu à questu. Di sicuru, pudete copià in Excel, calculate ciò chì avete bisognu è caricate e dati torna à Confluence. Pudete applicà una macro una volta? è uttene u listessu risultatu, solu aghjurnatu.
Per esempiu: avete una tavula chì cuntene i dati di tutti l'impiegati - induve si trovanu geograficamente è chì pusizioni sò. Per calculà quante persone sò in ogni cità, avete bisognu di selezziunà in a macro "Pivot Table" a fila da quale i dati sò aggregati (locu) è u tipu d'operazione (aghjunghje).
Naturalmente, pudete aggrupà secondu parechji criterii à una volta, pudete vede tutte e pussibulità .
Grafici (plugin pagatu)
Cumu l'aghju dettu, micca tutti amanu i tavulini quant'è mè. Sfortunatamente, a maiò parte di i gestori ùn li piacenu micca. Ma tutti amanu i charts di culori brillanti.
I creatori di Confluence certamenti sapianu di questu (di sicuru anu ancu patroni chì amanu i rapporti è i grafici, induve seranu senza ellu). Dunque, pudete aduprà a macro magica . In questa macro, avete bisognu di mette a tavola pivot da u paràgrafu precedente, è voilà - i vostri dati grisgi boring sò belli visualizati.
Naturalmente, sta macro hà ancu paràmetri. Un ligame à a documentazione per qualsiasi macro pò esse truvatu in u modu di edizione di quella macro.
Facilità di aggregazione
L'infurmazioni da i paragrafi precedenti ùn era micca probabilmente una rivelazione per voi. Ma avà sapete definitivamente cumu utilizà macros, è possu passà à a parte più interessante di l'articulu.
Etichetti
Hè male quandu a ghjente guarda l'infurmazioni in un articulu micca strutturatu o una tavola enormosa. Ancu peggiu hè quandu parti di sta infurmazione ùn sò micca solu illeggibili, ma ancu spargugliati in l'espansione di Confluence. Fortunatamente, hè pussibule di cullà infurmazioni spargugliati in un locu. Per questu avete bisognu di utilizà (tags familiari à tutti nantu à e rete suciale).
Ogni numeru di tag pò esse aghjuntu à ogni pagina. Cliccà nantu à una tag vi purterà à una pagina di aggregazione cù ligami à tuttu u cuntenutu cù quella tag, è ancu un set di tags rilativi. I tags Related sò quelli chì appariscenu spessu nantu à a stessa pagina.
Proprietà di a pagina
Pudete aghjunghje una altra macro interessante à a pagina per a strutturazione di l'infurmazioni - . Dentru, avete bisognu di mandà una tavola di dui culonni, u primu serà a chjave, è u sicondu serà u valore di a pruprietà. Inoltre, a macro pò esse oculata da a pagina per ùn interferiscenu micca cù a lettura di u cuntenutu, ma a pagina serà sempre marcata cù i chjavi necessarii.
Prestate attenzione à l'ID - hè cunvenutu per stabilisce per appiccà diversi gruppi di pruprietà in diverse pagine (o ancu diversi gruppi di pruprietà in una pagina).
Rapporti
Per tag, pudete cullà rapporti. Per esempiu, macro raccoglie tutte e pagine cù un certu settore di tag.
Ma un rapportu più interessante hè una macro . Hè ancu recullà tutte e pagine cù un certu settore di tags, ma ùn solu elencu, ma compila una tavula (avete a cunnissioni cù l'iniziu di l'articulu?), In quale i culonni sò i chjavi di e proprietà di a pagina.
Risulta un tavulu riassuntu di informazioni da diverse fonti. Hè bellu chì hà caratteristiche convenienti: layout adattativu, sorte per ogni colonna. Inoltre, una tale tabella di rapportu pò esse cunfigurata in a macro.
Quandu cunfigurà, pudete sguassà alcune colonne da u rapportu, stabilisce u statu predeterminatu o u nùmeru di registri visualizati. Pudete ancu stabilisce l'ID di pruprietà di a pagina per vede solu l'infurmazioni chì avete bisognu.
Per esempiu, avete assai pagine di l'impiegati, queste pagine anu un inseme di pruprietà nantu à una persona: chì livellu hè, induve hè, quandu si unisce à a squadra, è cusì. Sti pruprietà sò marcati id = employee_inf. È ci hè un secondu settore di pruprietà nantu à a stessa pagina, chì cuntene infurmazioni nantu à una persona cum'è parte di una squadra: quale rolu a persona cumporta, in quale squadra hè, è cusì. Sti pruprietà sò marcati ID = team_inf. Allora, quandu compilate un rapportu, pudete visualizà solu l'infurmazioni per una ID o duie à una volta - quellu chì hè più convenientu.
A bellezza di questu approcciu hè chì tutti ponu cullà a tavola d'infurmazioni chì anu bisognu, chì ùn duplicà nunda è serà aghjurnata quandu a pagina principale hè aghjurnata. Per esempiu: un capu di squadra ùn importa micca quandu i so sviluppatori anu avutu un travagliu, ma hè impurtante chì rolu ognunu di elli ghjucanu in a squadra. U capu di a squadra cuglierà un rapportu nantu à a squadra. È l'accountante ùn importa micca quale svolge quale rolu, ma i pusizioni sò impurtanti - cullà un rapportu nantu à e pusizioni. In questu casu, a fonte di l'infurmazioni ùn serà micca duplicata o trasferita.
Prucessu finali
Instructions
Dunque, pudemu strutturà bè è aggregate in modu efficace l'infurmazioni in Confluence usendu macros cum'è un esempiu. Ma idealmente, avete bisognu di assicurà chì a nova infurmazione hè subitu strutturata è entra in tutti i miccanismi di aggregazione digià in usu.
Quì una mansa di macros è mudelli venenu in salvezza. Per fà e persone per creà novi pagine in u formatu ghjustu, pudete aduprà a macro Crea da Template. Aghjunghje un buttone à a pagina, clicchendu nantu à quale una nova pagina hè creata da u mudellu chì avete bisognu. Questu modu fate chì e persone travaglianu immediatamente in u formatu chì avete bisognu.
In u mudellu da quale permette di creà una pagina, avete bisognu di aghjunghje etichette, a macro "Page Properties" è una tabella di e proprietà chì avete bisognu in anticipu. Aghju ricumandemu ancu di aghjunghje struzzioni nantu à quali valori per riempie a pagina è i valori di pruprietà.
Allora u prucessu finali sarà cusì:
- Stai criendu un mudellu per un tipu specificu di informazioni.
- In questu mudellu, aghjunghje etichette è proprietà di pagina in una macro.
- In ogni locu cunvene, crea una pagina di radica cù un buttone, clicchendu nantu à quale una pagina di u zitellu hè creata da u mudellu.
- Cumincià nantu à a pagina radicali di l'utilizatori chì potenzalmentu generà l'infurmazioni necessarii (sicondu u mudellu desideratu, clicchendu nantu à u buttone).
- Cullate sè stessu un rapportu nantu à e proprietà di a pagina attraversu i tags chì avete specificatu in u mudellu.
- Rejoice: avete tutte l'infurmazioni chì avete bisognu in un formatu convenientu.
Pitfalls
Cum'è un ingegnere di qualità, possu dì sicuru chì ùn ci hè nunda di perfettu in u mondu. Ancu i tavule divini sò imperfetti. E ci sò trappule in u prucessu di sopra.
- Se decide di cambià i nomi o a cumpusizioni di e proprietà di a pagina, avete da aghjurnà tutti l'uggetti digià creati in modu chì e so dati sò currettamente tirati in u rapportu di sintesi. Questu hè tristu, ma da l'altra banda, vi furzà à pensà in dettagliu nantu à "l'architettura" di u vostru settore d'infurmazioni, chì hè un compitu assai interessante.
- Avete da scrive una quantità decentu di struzzioni nantu à cumu riempie e tavule d'infurmazioni è aduprà e tag. Ma, da l'altra banda, pudete solu scaccià stu articulu à tutte e persone ghjustu.
Un esempiu di almacenà documentazione non-prodottu
Per mezu di u prucessu discritta sopra, pudete urganizà u almacenamiento di quasi ogni infurmazione. A bellezza di l'approcciu hè chì hè universale: una volta chì l'utilizatori s'abituanu, cessanu di fà un mess. Ancu un grande (ma micca liberu) plus hè a capacità di cullà diverse statistiche nantu à a mosca è tracciate belli diagrammi nantu à questu.
Daraghju un esempiu di u nostru prucessu di mantene l'infurmazioni nantu à a squadra.
Per ogni persona in a squadra, avemu decisu di creà una carta di l'impiegatu. In cunsiquenza, avemu un mudellu secondu chì ogni nova persona crea sta carta per ellu stessu è mantene tutte e so informazioni persunali in questu.
Comu pudete vede, avemu un tavulu detallatu di pruprietà è immediatamente avemu struzzioni nantu à cumu mantene sta pagina. Alcune di l'etichette sò messe da l'impiegati stessi secondu l'istruzzioni, in u mudellu solu i principali: u tag di carta carta di l'impiegatu, tag di direzzione direzzione-implica è tag di cumanda squadra-qa.
In u risultatu, dopu chì ognunu hà creatu una carta per elli, una tavola cumpleta cù l'infurmazioni nantu à l'impiegati hè ottenuta. Sta infurmazione pò esse usata in diversi punti. I gestori di risorse ponu cullà e tavule generale per elli stessi, è i capi di squadra ponu cullà i tavule di cummandu aghjunghjendu un tag di squadra à a selezzione.
By tags, vi ponu vede differente riassuntu, per esempiu, da qa-upgrade-plan tutti i travaglii per u sviluppu QA seranu visualizati. À u listessu tempu, ogni persona in a so carta di l'impiegatu mantene una storia impurtante è u so propiu pianu di sviluppu - crea una pagina nidificata da u mudellu di piani di sviluppu.
cunchiusioni
Mantene ogni ducumentazione in tale manera chì ùn site micca vergogna di questu, è l'utilizatori ùn sò micca feriti assai!
Spergu veramente chì l'articulu serà utile è l'ordine vene in tutta a documentazione di u mondu.
Source: www.habr.com