Hello kulħadd!
Jisimni Masha, naħdem bħala inġinier tal-assigurazzjoni tal-kwalità fil-grupp ta 'kumpaniji Tinkoff. Ix-xogħol tal-QA jinvolvi ħafna komunikazzjoni ma’ nies differenti minn timijiet differenti, u kont ukoll maniġer u lecturer ta’ programmi edukattivi, għalhekk il-mappa tal-komunikazzjoni tiegħi kienet wiesgħa kemm jista’ jkun. U f'xi ħin splojt: indunajt li ma nistax, ma nistax, ma nistax nimla tunnellati infernali ta 'tabelli u dokumenti li ma jinqrawx.
Żgur li kull wieħed minnkom issa immaġina dak li qed nitkellem u faqqa’ b’għaraq kiesaħ: listi ta’ kunjomijiet mingħajr ordni alfabetiku, tabelli b’mijiet ta’ kolonni b’tqassim mgħawweġ, tabelli b’eluf ta’ linji li fihom trid timsaħ subgħajk. fuq ir-rota tal-maws biex tfittex header, tunnellati ta 'paġni ta' struzzjonijiet bla numru, mijiet ta 'ittri mibgħuta lil xulxin b'dejta li jeħtieġ li tiġi analizzata u sistematizzata u mimli f'tabelli ugwalment li ma jinqrawx.
U għalhekk, meta bqajt ftit, iddeċidejt li nikteb dan l-artiklu. Se nitkellem dwar kif tista 'normalment (anke kultant konvenjenti) iżżomm varjetà ta' dokumentazzjoni mhux tal-prodott. Nittama li l-artiklu jinfirex madwar l-Internet u l-livell tal-infern fid-dipartimenti li jmissu mal-iżvilupp jonqos mill-inqas ftit, u n-nies (inkluż jien) isiru ftit aktar kuntenti.
Għodod
Id-dokumentazzjoni tal-prodott ħafna drabi tinżamm ħdejn il-kodiċi, li hija ħaġa tajba. U d-dokumentazzjoni mhux tal-prodott normalment tinħażen kullimkien. In-nies ħafna drabi jippruvaw iċċaqilqu l-informazzjoni minn postijiet differenti għal Confluence, u aħna mhux eċċezzjoni. Allura l-bqija tal-istorja hija dwaru.
B'mod ġenerali, Confluence hija magna wiki avvanzata. Jippermettilek taħdem b'dejta f'tipi differenti ta 'wiri: test b'formattjar, tabelli, mapep varji. Din hija għodda interessanti u qawwija ħafna, imma jekk ma tafx kif tippreparaha, allura tispiċċa b'dump ieħor ta 'dokumenti li ma jinqrawx. Ngħallem kif issajjar!
Makros
Kważi l-maġija kollha ta’ Confluence ġejja minn macros. Hemm ħafna macros, u jistgħu jingħaqdu ma 'xulxin. Jistgħu jitħallsu jew b'xejn; hawn taħt se jkun hemm diversi eżempji ta' macros b'links għal dokumentazzjoni għalihom.
L-interface biex taħdem ma 'macros hija sempliċi kemm jista' jkun. Biex iżżid makro, trid tikklikkja fuq il-plus u tagħżel l-element mixtieq mil-lista.
Jekk makro tkun awtonoma, jiġifieri, ma teħtieġx li tiddaħħal xi ħaġa oħra ġewwa fiha nnifisha, tidher qisha blokka.
Jekk makro teħtieġ li titpoġġa xi ħaġa ġewwa fiha biex taħdem, tidher qisha qafas.
Fl-istess ħin, tista 'tpoġġi kemm trid oħrajn ġewwa qafas wieħed, sakemm ikun hemm loġika fil-piramida tiegħek.
Kull makro għandha preview: immedjatament turi jekk imlejtx u kkonfiguratx il-makro b'mod korrett.
templates
Minbarra l-macros, hemm għodda konvenjenti għall-mili minn qabel tal-kontenut - mudell.
Il-mudelli jistgħu jintużaw meta tinħoloq kwalunkwe paġna: sempliċement ikklikkja fuq it-tliet tikek ħdejn il-buttuna "Oħloq" u agħżel il-mudell mixtieq.
Imbagħad il-kontenut kollu li jkun fil-mudell se jiżdied mal-paġna maħluqa.
Kulħadd jista' joħloq paġni minn mudelli, iżda dawk biss li għandhom id-drittijiet li joħolqu jew jeditjaw il-mudelli huma stess jistgħu jagħmlu dan. Tista' żżid struzzjonijiet addizzjonali mal-mudell dwar kif għandha tinżamm il-paġna.
Il-maġija tat-tabelli
Fil-fatt, bħala techie, inħobb ħafna t-tabelli u nista' nagħlaq kważi kull informazzjoni fihom (għalkemm dan mhux dejjem effettiv). It-tabelli nfushom huma ċari, strutturati, skalabbli, maġiċi!
Iżda anke entità meraviljuża bħal mejda tista 'tiġi mħassra. U tista 'tużaha b'suċċess u saħansitra ttejjebha. Aktar dwar dan hawn taħt.
Iffiltrar (plugin imħallas)
Kwalunkwe tabella enormi u li ma tinqarax tista' ssir ftit inqas enormi u ftit aktar tinqara bl-użu tal-filtrazzjoni. Tista' tuża makro mħallsa għal dan .
Trid tpoġġi tabella ġewwa din il-makro (anke l-aktar waħda ikrah hija possibbli, il-ħaġa prinċipali hija li timbottaha fl-intier tagħha). Fil-makro, tista 'tagħżel kolonni għall-filtru drop-down, filtru tat-test, filtru numeriku, u filtru tad-data.
Immaġina biss li l-informazzjoni kollha dwar il-kandidati għall-postijiet vakanti kollha hija rreġistrata f'lista tabulari. Naturalment, mhux magħżula - in-nies jaslu għal intervisti mhux f'ordni alfabetiku. U trid tifhem jekk int intervistajtx applikant speċifiku qabel. Għandek bżonn biss li tpoġġi dan l-infern f'makro filtru, żid filtru tat-test bl-kunjom - u voila, l-informazzjoni tinsab fuq l-iskrin tiegħek.
Ta’ min jinnota li l-iffiltrar ta’ tabelli kbar jista’ jaffettwa l-prestazzjoni tas-sistema u l-ħinijiet tat-tagħbija tal-paġni, għalhekk it-tqegħid ta’ tabella enormi f’filtru huwa crutch temporanju; huwa aħjar li jinbena proċess li fih in-nies ma jkollhomx għalfejn joħolqu tabelli enormi u li ma jinqrawx ( eżempju tal-proċess se jkun fl-aħħar tal-artikolu).
Issortjar (plugin imħallas)
Bl-użu ta 'makro maġiku Tista 'wkoll tissettja l-għażla default fuq kwalunkwe kolonna u nnumera r-ringieli. Jew ikklikkja fuq kwalunkwe kolonna tat-tabella mdaħħla fil-makro tal-filtru, u l-issortjar se jseħħ minn dik il-kolonna.
Pereżempju, għandek l-istess tabella mal-applikanti u trid tistma kemm saru intervisti f'ċertu xahar - issortja skond id-data u kun kuntent.
Pivot tables (plugin imħallas)
Issa ejja ngħaddu għal każ aktar interessanti. Immaġina li t-tabella tiegħek hija enormi u trid tikkalkula xi ħaġa minnha. Naturalment, tista 'tikkopjaha f'Excel, tikkalkula dak li għandek bżonn u ttella' d-dejta lura lil Confluence. Tista' tuża l-makro darba? u tikseb l-istess riżultat, aġġornat biss.
Pereżempju: għandek tabella li tiġbor data mill-impjegati kollha - fejn jinsabu ġeografikament u liema pożizzjonijiet jokkupaw. Biex tikkalkula kemm hemm nies f'kull belt, trid tagħżel ir-ringiela fil-makro PivotTable li tiġbor id-dejta (lokazzjoni) u t-tip ta 'operazzjoni (żieda).
Naturalment, tista 'tiggruppa b'diversi kriterji f'daqqa, il-possibbiltajiet kollha jistgħu jitqiesu .
Ċarts (plugin imħallas)
Kif għedt, mhux kulħadd iħobb it-tabelli daqs jien. Sfortunatament, ħafna mill-maniġers ma jogħġobhom xejn. Imma kulħadd verament iħobb dijagrammi kkuluriti jgħajtu.
Il-ħallieqa ta 'Confluence ċertament kienu jafu dwar dan (probabbilment għandhom ukoll pumijiet li jħobbu r-rapporti u d-dijagrammi, fejn ikunu mingħajrha). Għalhekk, tista 'tuża l-makro magic . F'dan il-makro għandek bżonn tpoġġi t-tabella tal-pern mill-paragrafu ta 'qabel, u voila - id-dejta boring griża tiegħek hija viżwalizzata b'mod sabiħ.
Naturalment, din il-makro għandha wkoll settings. Link għad-dokumentazzjoni għal kwalunkwe makro tista 'tinstab fil-mod ta' editjar ta 'dik il-makro.
Aggregazzjoni faċli
L-informazzjoni mill-paragrafi preċedenti probabbilment ma kinitx rivelazzjoni għalik. Imma issa żgur taf kif tuża macros, u nista' ngħaddi għall-parti l-aktar interessanti tal-artiklu.
Tikketti
Huwa ħażin meta n-nies jaħżnu l-informazzjoni f'artikolu wieħed mhux strutturat jew tabella enormi. Huwa saħansitra agħar meta partijiet minn din l-informazzjoni mhumiex biss ifformattjati li ma jinqrawx, iżda wkoll imxerrda madwar Confluence. Fortunatament, huwa possibbli li tinġabar informazzjoni mxerrda f'post wieħed. Biex tagħmel dan għandek bżonn tuża (tags familjari għal kulħadd minn netwerks soċjali).
Tista 'żżid kull numru ta' tikketti ma 'kwalunkwe paġna. Meta tikklikkja fuq tag se tieħdok għal paġna ta' aggregazzjoni b'links għall-kontenut kollu b'dik it-tikketta, kif ukoll sett ta' tags relatati. Tikketti relatati huma dawk li jidhru ta' spiss fuq l-istess paġna.
Page Properties
Tista' żżid makro ieħor interessanti mal-paġna biex tistruttura l-informazzjoni - . Ġewwa fiha għandek bżonn tissottometti tabella ta 'żewġ kolonni, l-ewwel tkun iċ-ċavetta, u t-tieni tkun il-valur tal-proprjetà. Barra minn hekk, il-makro jista 'jinħeba mill-paġna sabiex ma jinterferixxix mal-qari tal-kontenut, iżda l-paġna xorta tkun immarkata biċ-ċwievet meħtieġa.
Oqgħod attent għall-ID - huwa konvenjenti li tissettjaha biex tassenja gruppi differenti ta 'proprjetajiet għal paġni differenti (jew anke gruppi differenti ta' proprjetajiet għal paġna waħda).
Rapporti
Tista' tiġbor rapporti billi tuża tags. Per eżempju, makro jiġbor il-paġni kollha b'sett speċifiku ta' tikketti.
Iżda rapport aktar interessanti huwa l-makro . Jiġbor ukoll il-paġni kollha b'ċertu sett ta' tikketti, iżda mhux biss juri lista tagħhom, iżda joħloq tabella (taqbad il-konnessjoni mal-bidu tal-artiklu?), li fiha l-kolonni huma l-paġna ċwievet tal-proprjetà.
Ir-riżultat huwa tabella fil-qosor ta 'informazzjoni minn sorsi differenti. Huwa sabiħ li għandu funzjonijiet konvenjenti: tqassim adattiv, issortjar minn kwalunkwe kolonna. Ukoll, tabella ta 'rappurtar bħal din tista' tiġi kkonfigurata ġewwa makro.
Meta tikkonfigura, tista 'tneħħi xi kolonni mir-rapport, issettja stat default jew in-numru ta' rekords murija. Tista' wkoll tissettja l-ID tal-proprjetà tal-paġna biex tara biss l-informazzjoni li għandek bżonn.
Pereżempju, għandek ħafna paġni tal-impjegati, dawn il-paġni għandhom sett ta 'proprjetajiet dwar il-persuna: liema livell huwa, fejn hu, meta ngħaqad mat-tim, eċċ. Dawn il-proprjetajiet huma mmarkati ID = impjegat_inf. U hemm it-tieni sett ta 'proprjetajiet fuq l-istess paġna, li fih informazzjoni dwar il-persuna bħala parti mit-tim: x'rwol għandha l-persuna, f'liema tim hija, eċċ. Dawn il-proprjetajiet huma mmarkati ID = team_inf. Imbagħad, meta tikkumpila rapport, tista 'turi biss informazzjoni għal ID waħda jew tnejn f'daqqa - liema minnhom ikun l-aktar konvenjenti.
Is-sbuħija ta 'dan l-approċċ hija li kulħadd jista' jiġbor it-tabella ta 'informazzjoni li għandu bżonn, li ma tidduplika xejn u se tiġi aġġornata meta l-paġna ewlenija tiġi aġġornata. Per eżempju: ma jimpurtax li tim imexxi meta l-iżviluppaturi tiegħu kisbu impjieg, iżda huwa importanti x'rwol għandu kull wieħed minnhom fit-tim. Il-mexxej tat-tim se jiġbor rapport dwar it-tim. U l-accountant ġeneralment ma jimpurtax min iwettaq liema rwol, iżda l-pożizzjonijiet huma importanti - huwa se jikkompila rapport dwar il-pożizzjonijiet. F'dan il-każ, is-sors tal-informazzjoni mhux se jiġi duplikat jew trasferit.
Proċess finali
Istruzzjoni
Allura, nistgħu nistrutturaw b'mod sabiħ u naggregaw b'mod effettiv l-informazzjoni f'Confluence billi tuża macros bħala eżempju. Imma idealment, għandek bżonn tiżgura li informazzjoni ġdida tkun strutturata immedjatament u taqa 'fil-mekkaniżmi ta' aggregazzjoni kollha li diġà qed jintużaw.
Dan huwa fejn mazz ta 'makros u mudelli se jiġu għas-salvataġġ. Biex iġiegħel lin-nies joħolqu paġni ġodda fil-format mixtieq, tista 'tuża l-makro Oħloq minn Template. Hija żżid buttuna mal-paġna, meta kklikkjat, tinħoloq paġna ġdida mill-mudell li għandek bżonn. Dan il-mod iġiegħel lin-nies jaħdmu immedjatament fil-format li għandek bżonn.
Fil-mudell li minnu toħloq paġna, għandek bżonn iżżid tikketti, makro "Proprjetajiet tal-Paġni" u tabella tal-proprjetajiet li għandek bżonn minn qabel. Nirrakkomanda wkoll li żżid struzzjonijiet dwar liema valuri għandhom jimtlew fil-paġna, u valuri tal-proprjetà.
Imbagħad il-proċess finali se jidher bħal dan:
- Inti toħloq mudell għal tip speċifiku ta 'informazzjoni.
- F'dan il-mudell inti żżid tikketti u proprjetajiet tal-paġna f'makro.
- Fi kwalunkwe post konvenjenti, oħloq paġna għerq b'buttuna, li tikklikkja fuqha toħloq paġna tifel mill-mudell.
- Int tħalli lill-utenti jmorru fil-paġna tal-għeruq, li potenzjalment jiġġeneraw l-informazzjoni meħtieġa (skont il-mudell meħtieġ, billi tikklikkja fuq buttuna).
- Inti tiġbor rapport fuq il-proprjetajiet tal-paġna billi tuża t-tikketti li speċifikajt fil-mudell.
- Tiċċelebra: għandek l-informazzjoni kollha meħtieġa f'format konvenjenti.
Iżvantaġġi
Bħala inġinier ta 'kwalità, nista' ngħid b'mod sikur li xejn mhu perfett fid-dinja. Anke l-imwejjed divini huma imperfetti. U hemm nases fil-proċess ta 'hawn fuq.
- Jekk tiddeċiedi li tibdel l-ismijiet jew il-kompożizzjoni tal-proprjetajiet tal-paġna, ikollok taġġorna l-oġġetti kollha diġà maħluqa sabiex id-dejta tagħhom tkun inkluża b'mod korrett fir-rapport sommarju. Dan huwa diqa, iżda, min-naħa l-oħra, iġġiegħlek taħseb fid-dettall dwar l-"arkitettura" tas-sett ta 'informazzjoni tiegħek, li hija kompitu interessanti ħafna.
- Ikollok tikteb ammont ġust ta 'struzzjonijiet dwar kif timla tabelli ta' informazzjoni u tuża tikketti. Iżda min-naħa l-oħra, tista 'sempliċement tolqot lin-nies it-tajbin kollha b'dan l-artikolu.
Eżempju ta' ħażna ta' dokumentazzjoni mhux tal-prodott
Permezz tal-proċess deskritt hawn fuq, tista 'torganizza l-ħażna ta' kważi kull informazzjoni. Is-sbuħija tal-approċċ hija li huwa universali: ladarba l-utenti jidraw, jieqfu jiġġeneraw mess. Plus kbir ieħor (iżda mhux b'xejn) huwa l-abbiltà li tiġbor diversi statistiċi fuq il-fly u tfassal dijagrammi sbieħ ibbażati fuqhom.
Ħa nagħtikom eżempju tal-proċess tagħna biex inżommu l-informazzjoni dwar tim.
Iddeċidejna li noħolqu karta tal-impjegat għal kull persuna fit-tim. Għaldaqstant, għandna mudell li skontu kull persuna ġdida toħloq din il-karta għaliha nnifisha u żżomm l-informazzjoni personali kollha fiha.
Kif tistgħu taraw, għandna tabella dettaljata tal-proprjetajiet u immedjatament għandna struzzjonijiet dwar kif eżattament iżżomm din il-paġna. Xi wħud mit-tags huma miżjuda mill-impjegati nfushom skond l-istruzzjonijiet; il-mudell fih biss dawk ewlenin: tikketta tal-biljett karta tal-impjegat, tikketta tad-direzzjoni direzzjoni-involvi u tag tim tim-qa.
Bħala riżultat, wara li kulħadd ħoloq karta għalih innifsu, tinkiseb tabella kompluta b'informazzjoni dwar l-impjegati. Din l-informazzjoni tista' tintuża f'punti differenti. Il-maniġers tar-riżorsi jistgħu jiġbru tabelli ġenerali għalihom infushom, u l-mexxejja tat-tim jistgħu joħolqu tabelli tat-tim billi jżidu tikketta tat-tim mal-għażla.
Tista' tara sommarji differenti permezz ta' tags, pereżempju qa-upgrade-plan Il-kompiti kollha tal-iżvilupp tal-QA se jintwerew. Fl-istess ħin, kull persuna żżomm storja importanti u l-pjan ta 'żvilupp tagħha stess fil-karta tal-impjegat tagħha - toħloq paġna nested mill-mudell tal-pjanijiet ta' żvilupp.
Konklużjoni
Żomm kwalunkwe dokumentazzjoni b'tali mod li ma jkunx hemm mistħija fiha, u ma tikkawżax uġigħ kbir għall-utenti!
Verament nittama li l-artiklu jkun utli u l-ordni jasal għad-dokumentazzjoni kollha fid-dinja.
Sors: www.habr.com