Hallo almal!
My naam is Masha, ek werk as 'n kwaliteitsversekeringsingenieur in die Tinkoff-groep van maatskappye. QA-werk behels baie kommunikasie met verskillende mense uit verskillende spanne, en ek was ook 'n bestuurder en dosent van opvoedkundige programme, so my kommunikasiekaart was so wyd as moontlik. En op 'n stadium het ek ontplof: ek het besef dat ek nie meer kan nie, ek kan nie, ek kan nie helse tonne onleesbare tabelle en dokumente invul nie.
Elkeen van julle het sekerlik nou verbeel waarvan ek praat, en het koud gesweet: lyste vanne sonder alfabetiese volgorde, tabelle met honderde kolomme met 'n slordige uitleg, tabelle met duisende reëls waarin jy jou vinger moet uitvee op die muiswiel om opskrif te kyk, tonne bladsye van ongenommerde instruksies, honderde briewe wat aan mekaar gestuur is met data wat ontleed en gesistematiseer moet word en in dieselfde onleesbare tabelle gestop moet word.
En so, toe ek bietjie afgekoel het, het ek besluit om hierdie artikel te skryf. Ek sal praat oor hoe jy normaalweg (selfs soms gerieflik) 'n verskeidenheid nie-produkdokumentasie kan onderhou. Ek hoop dat die artikel oor die netwerk sal strooi en die vlak van hel in die departemente aangrensend aan die ontwikkeling sal ten minste 'n bietjie daal, en mense (insluitend ek) sal 'n bietjie gelukkiger word.
Tools
Produkdokumentasie word dikwels langs kode gehou, wat 'n goeie ding is. En nie-produk dokumentasie word gewoonlik oral gestoor. Dikwels probeer mense om inligting van verskillende plekke na Confluence in te bring, en ons is geen uitsondering nie. Die res van die storie gaan dus oor hom.
Oor die algemeen is Confluence 'n gevorderde wiki-enjin. Dit laat jou toe om met data te werk in verskillende tipes vertoon: teks met formatering, tabelle, verskeie kaarte. Dit is 'n baie interessante en kragtige instrument, maar as jy nie weet hoe om dit te kook nie, sal jy nog 'n storting van onleesbare dokumente kry. Ek sal jou leer hoe om te kook!
Makros
Byna al die magie van Confluence is gebou rondom makro's. Daar is baie makro's, en hulle kan met mekaar gekombineer word. Hulle is betaal en gratis, verder sal daar verskeie voorbeelde van makro's wees met skakels na dokumentasie daarvoor.
Die koppelvlak om met makro's te werk is so eenvoudig as moontlik. Om 'n makro by te voeg, moet jy op die plus klik en die gewenste element uit die lys kies.
As die makro selfversorgend is, dit wil sê, dit vereis nie die invoeging van iets anders binne homself nie, dit lyk soos 'n blok.
As 'n makro iets in hom nodig het om te werk, lyk dit soos 'n boks.
Terselfdertyd kan jy soveel ander as wat jy wil binne een raam plaas, solank daar logika in jou piramide is.
Elke makro het 'n voorskou: dit wys dadelik of jy die makro korrek ingevul en gekonfigureer het.
templates
Benewens makro's, is daar 'n gerieflike hulpmiddel om inhoud vooraf in te vul - dit is 'n sjabloon.
Sjablone kan gebruik word wanneer enige bladsy geskep word: klik net op die drie kolletjies langs die "Skep"-knoppie en kies die verlangde sjabloon.
Dan sal al die inhoud wat in die sjabloon is, by die geskepte bladsy gevoeg word.
Enigiemand kan bladsye van sjablone skep, maar slegs diegene wat die regte het om self sjablone te skep of te wysig kan bladsye skep. Jy kan bykomende instruksies by die sjabloon voeg oor hoe die bladsy in stand gehou moet word.
Tafelmagie
Eintlik, as 'n tegnikus, is ek baie lief vir tafels en kan byna enige inligting daarin toedraai (hoewel dit nie altyd effektief is nie). Die tabelle self is duidelik, gestruktureerd, skaalbaar, magies!
Maar selfs so 'n wonderlike entiteit soos 'n tafel kan bederf word. En dit kan suksesvol gebruik en selfs verbeter word. Meer daaroor hieronder.
Filtrering (betaalde inprop)
Enige groot onleesbare tabel kan met behulp van filter 'n bietjie minder groot en 'n bietjie meer leesbaar gemaak word. Om dit te doen, kan jy 'n betaalde makro gebruik .
Binne hierdie makro moet jy 'n tafel skuif (selfs die lelikste een is moontlik, die belangrikste ding is om dit heeltemal te skuif). In die makro kan jy kolomme kies vir aftrekfilter, teksfilter, numeriese en datumfilter.
Verbeel jou net dat alle inligting oor kandidate vir alle vakatures in 'n tabellys aangeteken word. Natuurlik, ongesorteer - mense kom nie na onderhoude in alfabetiese volgorde nie. En jy moet verstaan of jy voorheen 'n spesifieke aansoeker ondervra het. Jy hoef net hierdie hel in 'n filter-makro te plaas, 'n teksfilter volgens van by te voeg - en voila, die inligting is op jou skerm.
Dit is opmerklik dat die filter van groot tabelle stelselwerkverrigting en bladsylaaityd kan beïnvloed, so om 'n groot tabel in die filter te plaas is 'n tydelike kruk, dit is beter om 'n proses te bou waarin mense nie groot onleesbare tabelle hoef te skep nie ('n voorbeeld van die proses sal aan die einde van die artikel wees).
Sorteer (betaalde inprop)
Met Magic Macro jy kan ook die versteksortering op enige kolom stel en die rye nommer. Of klik op enige kolom van die tabel wat in die filtermakro geplaas word, en sorteer volgens hierdie kolom sal plaasvind.
Jy het byvoorbeeld dieselfde tabel met aansoekers en jy moet uitvind hoeveel onderhoude in ’n sekere maand gehou is – sorteer volgens datum en wees bly.
Spiltafels (betaalde inprop)
Kom ons gaan nou oor na 'n meer interessante saak. Stel jou voor dat jou tafel groot is en dat jy iets daarop moet bereken. Natuurlik kan jy dit na Excel kopieer, bereken wat jy nodig het en die data terug oplaai na Confluence. Kan jy een keer 'n makro toepas? en kry dieselfde resultaat, net opgedateer.
Byvoorbeeld: jy het 'n tabel wat die data van alle werknemers bevat - waar hulle geografies geleë is en watter posisies hulle beklee. Om te bereken hoeveel mense in elke stad is, moet jy in die "Pivot Table" makro die ry kies waarmee die data saamgevoeg word (ligging) en die tipe bewerking (byvoeging).
U kan natuurlik volgens verskeie kriteria tegelyk groepeer, u kan al die moontlikhede sien .
Charts (betaalde inprop)
Soos ek gesê het, nie almal is so lief vir tafels soos ek nie. Ongelukkig hou die meeste bestuurders glad nie van hulle nie. Maar almal hou van helder kleurkaarte.
Die skeppers van Confluence het beslis hiervan geweet (hulle het sekerlik ook base wat lief is vir verslae en kaarte, waar sou hulle daarsonder wees). Daarom kan jy die magiese makro gebruik . In hierdie makro moet jy die spiltabel van die vorige paragraaf plaas, en voila - jou vervelige grys data is pragtig gevisualiseer.
Natuurlik het hierdie makro ook instellings. 'n Skakel na die dokumentasie vir enige makro kan gevind word in die redigeermodus van daardie makro.
Gemak van samevoeging
Die inligting uit die vorige paragrawe was waarskynlik nie vir jou 'n openbaring nie. Maar nou weet jy beslis hoe om makro's te gebruik, en ek kan aanbeweeg na die meer interessante deel van die artikel.
Tags
Dit is sleg as mense inligting in een ongestruktureerde artikel of 'n groot tabel stoor. Nog erger is wanneer dele van hierdie inligting nie net onleesbaar is nie, maar ook oor die uitgestrekte van Samevloeiing versprei is. Gelukkig is dit moontlik om verspreide inligting op een plek te versamel. Hiervoor moet jy gebruik (etikette wat aan almal op sosiale netwerke bekend is).
Enige aantal merkers kan by enige bladsy gevoeg word. As u op 'n merker klik, sal u na 'n samevoegingsbladsy neem met skakels na alle inhoud met daardie merker, sowel as 'n stel verwante merkers. Verwante merkers is dié wat gereeld op dieselfde bladsy verskyn.
Bladsy-eienskappe
Jy kan nog 'n interessante makro by die bladsy voeg om inligting te struktureer - . Binne dit moet jy 'n tabel van twee kolomme indien, die eerste sal die sleutel wees, en die tweede sal die waarde van die eiendom wees. Boonop kan die makro van die bladsy weggesteek word sodat dit nie inmeng met die lees van die inhoud nie, maar die bladsy sal steeds met die nodige sleutels gemerk word.
Gee aandag aan die ID - dit is gerieflik om dit te stel om verskillende groepe eiendomme op verskillende bladsye (of selfs verskillende groepe eiendomme op een bladsy) te hang.
verslae
Deur etikette kan jy verslae insamel. Byvoorbeeld, makro versamel alle bladsye met 'n sekere stel etikette.
Maar 'n meer interessante verslag is 'n makro . Dit versamel ook alle bladsye met 'n sekere stel etikette, maar lys hulle nie net nie, maar stel 'n tabel saam (vang jy die verband met die begin van die artikel?), waarin die kolomme die sleutels van die bladsy-eienskappe is.
Dit blyk 'n opsommingstabel van inligting uit verskillende bronne. Dit is lekker dat dit gerieflike kenmerke het: aanpasbare uitleg, sorteer volgens enige kolom. So 'n verslagtabel kan ook binne die makro gekonfigureer word.
Wanneer u opstel, kan u sommige kolomme uit die verslag verwyder, die verstekstatus of die aantal vertoonde rekords stel. U kan ook die bladsy-eiendom-ID instel om slegs die inligting te sien wat u benodig.
Byvoorbeeld, jy het baie werknemerbladsye, hierdie bladsye het 'n stel eienskappe oor 'n persoon: watter vlak hy is, waar hy is, wanneer hy by die span aangesluit het, ensovoorts. Hierdie eiendomme is gemerk id = werknemer_inf. En daar is 'n tweede stel eienskappe op dieselfde bladsy, wat inligting bevat oor 'n persoon as deel van 'n span: watter rol die persoon vertolk, in watter span hy is, ensovoorts. Hierdie eiendomme is gemerk ID = span_inf. Dan, wanneer jy 'n verslag saamstel, kan jy slegs inligting vir een ID of twee op een slag vertoon - wat ook al die gerieflikste is.
Die skoonheid van hierdie benadering is dat almal die inligtingstabel wat hulle benodig kan versamel, wat niks sal dupliseer nie en opgedateer sal word wanneer die hoofblad opgedateer word. Byvoorbeeld: 'n spanleier gee nie om wanneer sy ontwikkelaars werk gekry het nie, maar dit is belangrik watter rol elkeen van hulle in die span speel. Die spanleier sal 'n verslag oor die span insamel. En die rekenmeester gee nie om wie watter rol verrig nie, maar die posisies is belangrik - hy sal 'n verslag oor die posisies insamel. In hierdie geval sal die bron van inligting nie gedupliseer of oorgedra word nie.
Finale proses
Onderrig
Dus, ons kan inligting pragtig struktureer en effektief saamvoeg in Confluence deur makro's as voorbeeld te gebruik. Maar ideaal gesproke moet jy seker maak dat nuwe inligting onmiddellik gestruktureer word en in al die samevoegingsmeganismes wat reeds gebruik word, inkom.
Hier sal 'n klomp makro's en sjablone tot die redding kom. Om mense te kry om nuwe bladsye in die regte formaat te skep, kan jy die Skep van sjabloon-makro gebruik. Dit voeg 'n knoppie by die bladsy, deur te klik waarop 'n nuwe bladsy geskep word uit die sjabloon wat jy benodig. Op hierdie manier dwing jy mense om dadelik te werk in die formaat wat jy nodig het.
In die sjabloon waaruit u toelaat om 'n bladsy te skep, moet u etikette, die "Bladsy-eienskappe"-makro en 'n tabel van die eienskappe wat u vooraf benodig, byvoeg. Ek beveel ook aan om instruksies by te voeg oor watter waardes om die bladsy te vul en eiendomswaardes.
Dan sal die finale proses soos volg lyk:
- Jy skep 'n sjabloon vir 'n spesifieke tipe inligting.
- Voeg in hierdie sjabloon byskrifte en bladsy-eienskappe in 'n makro by.
- Skep op enige gerieflike plek 'n wortelbladsy met 'n knoppie, deur te klik waarop 'n kinderbladsy vanaf die sjabloon geskep word.
- Begin op die wortelbladsy van gebruikers wat moontlik die nodige inligting sal genereer (volgens die verlangde sjabloon, deur op die knoppie te klik).
- Versamel vir jou 'n verslag oor die eienskappe van die bladsy deur die merkers wat jy in die sjabloon gespesifiseer het.
- Wees bly: jy het al die inligting wat jy nodig het in 'n gerieflike formaat.
Slaggate
As 'n kwaliteit ingenieur kan ek met sekerheid sê dat daar niks perfek in die wêreld is nie. Selfs goddelike tafels is onvolmaak. En daar is slaggate in bogenoemde proses.
- As jy besluit om die name of samestelling van die bladsy-eienskappe te verander, sal jy al die reeds geskepte voorwerpe moet opdateer sodat hulle data korrek in die opsommingsverslag ingetrek word. Dit is hartseer, maar aan die ander kant dwing dit jou om in detail te dink oor die "argitektuur" van jou inligtingstel, wat 'n baie interessante taak is.
- Jy sal 'n ordentlike hoeveelheid instruksies moet skryf oor hoe om die inligtingstabelle in te vul en die etikette te gebruik. Maar aan die ander kant kan jy hierdie artikel net na al die regte mense gooi.
'n Voorbeeld van die berging van nie-produk dokumentasie
Deur die proses hierbo beskryf, kan jy die berging van byna enige inligting organiseer. Die skoonheid van die benadering is dat dit universeel is: sodra gebruikers daaraan gewoond is, hou hulle op om 'n gemors te maak. Ook 'n groot (maar nie gratis nie) pluspunt is die vermoë om verskeie statistieke dadelik in te samel en pragtige diagramme daarop te teken.
Ek sal 'n voorbeeld gee van ons proses om inligting oor die span in stand te hou.
Vir elke persoon in die span het ons besluit om 'n werknemerkaart te skep. Gevolglik het ons 'n sjabloon waarvolgens elke nuwe persoon hierdie kaart vir homself skep en al sy persoonlike inligting daarin hou.
Soos u kan sien, het ons 'n gedetailleerde tabel van eiendomme en het ons onmiddellik instruksies oor hoe om hierdie bladsy te onderhou. Sommige van die etikette word deur die werknemers self neergesit volgens die instruksies, in die sjabloon slegs die belangrikstes: die kaartplaatjie werknemer-kaart, rigtingmerker rigting-betrek en opdrag tag span-qa.
Gevolglik word 'n volledige tabel met inligting oor werknemers verkry nadat elkeen vir hulself 'n kaart geskep het. Hierdie inligting kan op verskillende punte gebruik word. Hulpbronbestuurders kan algemene tabelle vir hulself insamel, en spanleiers kan opdragtabelle insamel deur 'n spanmerker by die keuse te voeg.
Deur etikette kan jy verskillende opsommings sien, byvoorbeeld deur qa-opgraderingsplan alle take vir QA-ontwikkeling sal vertoon word. Terselfdertyd hou elke persoon in sy werknemerkaart 'n belangrike storie en sy eie ontwikkelingsplan - hy skep 'n geneste bladsy uit die ontwikkelingsplan-sjabloon.
Gevolgtrekking
Hou enige dokumentasie op so 'n manier dat jy nie skaam is daaroor nie, en gebruikers nie ontsettend seergemaak word nie!
Ek hoop regtig dat die artikel nuttig sal wees en orde sal kom in al die dokumentasie van die wêreld.
Bron: will.com