Hello everyone!
Myn namme is Masha, ik wurkje as yngenieur foar kwaliteitsfersekering yn 'e Tinkoff-groep fan bedriuwen. QA wurk giet om in soad kommunikaasje mei ferskillende minsken út ferskillende teams, en ik wie ek in manager en dosint fan edukative programma, sadat myn kommunikaasje map wie sa breed mooglik. En op in stuit eksplodearre ik: ik realisearre dat ik net mear kin, ik kin net, ik kin gjin helske tonnen ûnlêsbere tabellen en dokuminten ynfolje.
Wis, elk fan jimme hat no foarsteld wêr't ik it oer ha, en bruts yn in kâld swit: listen mei efternammen sûnder alfabetyske folchoarder, tabellen mei hûnderten kolommen mei in sleauwe opmaak, tabellen mei tûzenen rigels dêr't jo de finger yn wiskje moatte op it mûs tsjil om heading te sjen, tonnen siden mei ûnnûmere ynstruksjes, hûnderten brieven nei elkoar stjoerd mei gegevens dy't analysearre en systematisearre wurde moatte en yn deselde ûnlêsbere tabellen stopje moatte.
En sa, doe't ik wat ôfkuolle, besleat ik dit artikel te skriuwen. Ik sil prate oer hoe't jo normaal (sels soms handich) kinne ûnderhâlde in ferskaat oan net-produkt dokumintaasje. Ik hoopje dat it artikel oer it netwurk sil ferspriede en it nivo fan 'e hel yn' e ôfdielingen neist de ûntwikkeling sil op syn minst in bytsje sakje, en minsken (ynklusyf my) sille in bytsje lokkiger wurde.
Tools
Produktdokumintaasje wurdt faak njonken koade bewarre, wat in goede saak is. En net-produkt dokumintaasje wurdt meastal opslein oeral. Faak besykje minsken te bringen ynformaasje fan ferskate plakken yn Confluence, en wy binne gjin útsûndering. Sa giet de rest fan it ferhaal oer him.
Yn 't algemien is Confluence in avansearre wiki-motor. It lit jo wurkje mei gegevens yn ferskate soarten werjefte: tekst mei opmaak, tabellen, ferskate diagrammen. Dit is in heul ynteressant en krêftich ark, mar as jo net witte hoe't jo it kokje, dan krije jo in oare dump fan net lêsbere dokuminten. Ik sil jo leare hoe te koken!
Makro's
Hast alle magy fan Confluence is boud om makro's. Der binne in protte makro, en se kinne wurde kombinearre mei elkoar. Se binne betelle en fergees, fierder sille d'r ferskate foarbylden fan makro's wêze mei keppelings nei dokumintaasje foar har.
De ynterface foar it wurkjen mei makro's is sa ienfâldich mooglik. Om in makro ta te foegjen, moatte jo klikke op de plus en selektearje it winske elemint út 'e list.
As de makro selsfoarsjennend is, dat is, it is net nedich om wat oars yn te setten, it liket in blok.
As in makro wat deryn nedich is om te wurkjen, liket it op in doaze.
Tagelyk kinne jo safolle oaren sette as jo wolle binnen ien frame, salang't d'r logika is yn jo piramide.
Elke makro hat in foarbyld: it lit fuortendaliks sjen oft jo de makro goed ynfolle en ynsteld hawwe.
Templates
Neist makro's is d'r in handich ark foar it ynfoljen fan ynhâld - dit is in sjabloan.
Sjabloanen kinne brûkt wurde by it meitsjen fan elke side: klik gewoan op de trije stippen neist de knop "Meitsje" en selektearje it winske sjabloan.
Dan sil alle ynhâld dy't yn it sjabloan is tafoege oan 'e oanmakke side.
Elkenien kin siden meitsje fan sjabloanen, mar allinich dejingen dy't de rjochten hawwe om sels sjabloanen te meitsjen of te bewurkjen kinne siden meitsje. Jo kinne ekstra ynstruksjes tafoegje oan it sjabloan oer hoe't de side ûnderhâlden wurde moat.
Tabel Magic
Eins, as technyk, hâld ik tige fan tabellen en kin ik hast alle ynformaasje yn har ferpakke (hoewol dit net altyd effektyf is). De tabellen sels binne dúdlik, strukturearre, scalable, magysk!
Mar sels sa'n prachtige entiteit as in tafel kin bedoarn wurde. En it kin mei súkses brûkt wurde en sels ferbettere. Mear oer dat hjirûnder.
Filtering (betelle plugin)
Elke enoarme ûnlêsbere tabel kin in bytsje minder enoarm en in bytsje lêsber makke wurde mei filterjen. Om dit te dwaan kinne jo in betelle makro brûke .
Binnen dizze makro moatte jo in tafel skodzje (sels de lelijkste is mooglik, it wichtichste is om it folslein te skowen). Yn 'e makro kinne jo kolommen selektearje foar útklapfilter, tekstfilter, numerike en datumfilter.
Stel jo gewoan foar dat alle ynformaasje oer kandidaten foar alle fakatueres wurdt opnommen yn in tabellist. Fansels, net sortearre - minsken komme net nei ynterviews yn alfabetyske folchoarder. En jo moatte begripe as jo earder in spesifike oanfreger hawwe ynterviewd. Jo moatte gewoan dizze hel yn in filtermakro sette, in tekstfilter tafoegje op efternamme - en voila, de ynformaasje is op jo skerm.
It is de muoite wurdich op te merken dat it filterjen fan enoarme tabellen de systeemprestaasjes en side-laadtiid kin beynfloedzje, dus it pleatsen fan in enoarme tabel yn it filter is in tydlike kruk, it is better om in proses te bouwen wêryn minsken gjin enoarme ûnlêsbere tabellen hoege te meitsjen (in foarbyld fan it proses sil wêze oan 'e ein fan it artikel).
Sortearje (betelle plugin)
Mei Magic Macro jo kinne ek de standert sortearring ynstelle op elke kolom en nûmer de rigen. Of klikje op elke kolom fan 'e tabel dy't yn' e filtermakro set is, en sortearje op dizze kolom sil foarkomme.
Bygelyks, jo hawwe deselde tafel mei oanfregers en jo moatte útfine hoefolle ynterviews waarden hâlden yn in bepaalde moanne - sortearje op datum en bliid wêze.
Pivottabellen (betelle plugin)
Litte wy no gean nei in nijsgjirriger gefal. Stel jo foar dat jo tafel enoarm is en dat jo der wat op moatte berekkenje. Fansels kinne jo it kopiearje nei Excel, berekkenje wat jo nedich binne en de gegevens werom uploade nei Confluence. Kinne jo ien kear in makro tapasse? en krije itselde resultaat, allinne bywurke.
Bygelyks: jo hawwe in tabel dy't de gegevens fan alle meiwurkers befettet - wêr't se geografysk lizze en hokker posysjes se hawwe. Om te berekkenjen hoefolle minsken yn elke stêd binne, moatte jo yn 'e makro "Pivottabel" de rige selektearje wêrmei't de gegevens wurde sammele (lokaasje) en it type operaasje (tafoeging).
Fansels kinne jo groepearje neffens ferskate kritearia tagelyk, jo kinne alle mooglikheden sjen .
Charts (betelle plugin)
As ik sei, net elkenien hâldt fan tafels safolle as ik. Spitigernôch hâlde de measte managers der hielendal net fan. Mar elkenien hâldt fan ljochte kleurkaarten.
De makkers fan Confluence wisten dit grif (se hawwe wis ek bazen dy't fan rapporten en charts hâlde, wêr soene se sûnder wêze). Dêrom kinne jo de magyske makro brûke . Yn dizze makro moatte jo de pivot-tabel fan 'e foarige paragraaf sette, en voila - jo saaie grize gegevens binne prachtich fisualisearre.
Fansels hat dizze makro ek ynstellings. In keppeling nei de dokumintaasje foar elke makro is te finen yn de bewurkingsmodus fan dy makro.
Gemak fan aggregaasje
De ynformaasje út 'e foarige paragrafen wie wierskynlik gjin iepenbiering foar jo. Mar no witte jo perfoarst hoe't jo makro's brûke, en ik kin trochgean nei it nijsgjirriger diel fan it artikel.
tags
It is slim as minsken ynformaasje opslaan yn ien unstrukturearre artikel as in enoarme tabel. Noch slimmer is as dielen fan dizze ynformaasje net allinich net lêsber binne, mar ek ferspraat oer de útwreidingen fan Confluence. Gelokkich is it mooglik om fersprate ynformaasje op ien plak te sammeljen. Hjirfoar moatte jo brûke (tags bekend foar elkenien op sosjale netwurken).
Elk oantal tags kinne wurde tafoege oan elke side. Klikje op in tag sil jo nei in aggregaasjeside bringe mei keppelings nei alle ynhâld mei dat tag, lykas ek in set fan relatearre tags. Related tags binne dyjingen dy't faak ferskine op deselde side.
Side eigenskippen
Jo kinne in oare ynteressante makro tafoegje oan 'e side foar strukturearjen fan ynformaasje - . Binnen it moatte jo in tabel fan twa kolommen yntsjinje, de earste sil de kaai wêze, en de twadde sil de wearde fan it pân wêze. Boppedat kin de makro fan 'e side ferburgen wurde, sadat it net ynterfereart mei it lêzen fan' e ynhâld, mar de side sil noch altyd markearre wurde mei de nedige kaaien.
Jou omtinken oan de ID - it is handich om it yn te stellen om ferskate groepen eigenskippen op ferskate siden te hingjen (of sels ferskate groepen eigenskippen op ien side).
Ferslaggen
Troch tags kinne jo rapporten sammelje. Bygelyks, makro sammelet alle siden mei in bepaalde set tags.
Mar in nijsgjirriger rapport is in makro . It sammelet ek alle siden mei in bepaalde set fan tags, mar list se net allinnich, mar kompilearret in tabel (fange jo de ferbining mei it begjin fan it artikel?), wêryn de kolommen binne de kaaien fan de side eigenskippen.
It docht bliken in gearfetting tabel fan ynformaasje út ferskate boarnen. It is moai dat it handige funksjes hat: adaptive yndieling, sortearje op elke kolom. Ek kin sa'n rapportaazjetabel yn 'e makro konfigureare wurde.
By it konfigurearjen kinne jo guon kolommen út it rapport fuortsmite, de standertstatus ynstelle of it oantal werjûn records. Jo kinne ek de side-eigendoms-ID ynstelle om allinich de ynformaasje te sjen dy't jo nedich binne.
Jo hawwe bygelyks in protte wurknimmerssiden, dizze siden hawwe in set eigenskippen oer in persoan: hokker nivo hy is, wêr't hy is, wannear't hy by it team kaam, ensfh. Dizze eigenskippen binne markearre id = wurknimmer_inf. En der is in twadde set eigenskippen op deselde side, dy't ynformaasje befettet oer in persoan as diel fan in team: hokker rol de persoan fiert, yn hokker team hy is, ensfh. Dizze eigenskippen binne markearre ID = team_inf. Dan, by it gearstallen fan in rapport, kinne jo allinich ynformaasje werjaan foar ien ID of twa tagelyk - wat it handiger is.
De skientme fan dizze oanpak is dat elkenien de ynformaasjetabel kin sammelje dy't se nedich binne, dy't neat sil duplisearje en wurde bywurke as de haadside bywurke wurdt. Bygelyks: in teamlieder makket it net út wannear't syn ûntwikkelders in baan krigen, mar it is wichtich hokker rol elk fan har yn it team spilet. De teamlieder sil in rapport sammelje oer it team. En de boekhâlder makket it net út wa't hokker rol útfiert, mar de posysjes binne wichtich - hy sil in rapport oer de posysjes sammelje. Yn dit gefal sil de boarne fan ynformaasje net duplikearre of oerdroegen wurde.
Finale proses
Ynstruksjes
Dat, wy kinne ynformaasje prachtich strukturearje en effektyf sammelje yn Confluence mei makro's as foarbyld. Mar ideaal moatte jo derfoar soargje dat nije ynformaasje daliks strukturearre is en komt yn alle aggregaasjemeganismen dy't al yn gebrûk binne.
Hjir sille in boskje makro's en sjabloanen ta de rêding komme. Om minsken te krijen om nije siden yn it juste formaat te meitsjen, kinne jo de Makro fan sjabloan brûke. It foeget in knop ta oan de side, troch te klikken wêrop in nije side wurdt makke fanút it sjabloan dat jo nedich binne. Op dizze manier meitsje jo minsken fuortendaliks wurkje yn it formaat dat jo nedich binne.
Yn it sjabloan wêrfan jo in side meitsje kinne, moatte jo labels taheakje, de makro "Page Properties" en in tabel mei de eigenskippen dy't jo foarôf nedich binne. Ik riede ek oan om ynstruksjes ta te foegjen oer hokker wearden om de side mei te foljen en eigendomswearden.
Dan sil it definitive proses der sa útsjen:
- Jo meitsje in sjabloan foar in spesifyk type ynformaasje.
- Foegje yn dit sjabloan labels en side-eigenskippen ta yn in makro.
- Meitsje op elk handich plak in root-side mei in knop, troch te klikken wêrop in bernside wurdt makke fanút it sjabloan.
- Start op 'e root-side fan brûkers dy't mooglik de nedige ynformaasje sille generearje (neffens it winske sjabloan, troch te klikken op de knop).
- Sammelje josels in rapport oer de eigenskippen fan 'e side troch de tags dy't jo hawwe opjûn yn it sjabloan.
- Bliid: jo hawwe alle ynformaasje dy't jo nedich binne yn in handich formaat.
falkûlen
As kwaliteit yngenieur, ik kin feilich sizze dat der is neat perfekt yn 'e wrâld. Sels godlike tafels binne ûnfolslein. En d'r binne falkûlen yn it boppesteande proses.
- As jo beslute om de nammen of gearstalling fan 'e side-eigenskippen te feroarjen, moatte jo alle al oanmakke objekten bywurkje, sadat har gegevens korrekt yn it gearfettingsrapport lutsen wurde. Dit is spitich, mar oan 'e oare kant twingt it jo om yn detail te tinken oer de "arsjitektuer" fan jo ynformaasjeset, wat in heul ynteressante taak is.
- Jo sille in fatsoenlike hoemannichte ynstruksjes moatte skriuwe oer hoe't jo de ynformaasjetabellen ynfolje en de tags brûke. Mar, oan 'e oare kant, kinne jo dit artikel gewoan nei alle juste minsken smite.
In foarbyld fan it bewarjen fan net-produkt dokumintaasje
Troch it hjirboppe beskreaune proses kinne jo de opslach fan hast alle ynformaasje organisearje. De skientme fan 'e oanpak is dat it universeel is: as brûkers ienris wend binne, stopje se mei it meitsjen fan in puinhoop. Ek in grut (mar net fergees) plus is de mooglikheid om ferskate statistiken op 'e flecht te sammeljen en der prachtige diagrammen op te tekenjen.
Ik sil in foarbyld jaan fan ús proses foar it behâld fan ynformaasje oer it team.
Foar elke persoan yn it team hawwe wy besletten om in wurknimmerkaart te meitsjen. Dêrom hawwe wy in sjabloan wêryn elke nije persoan dizze kaart foar himsels makket en al syn persoanlike ynformaasje dêryn hâldt.
Sa't jo sjen kinne, hawwe wy in detaillearre tabel mei eigenskippen en hawwe fuortendaliks ynstruksjes oer hoe't jo dizze side kinne ûnderhâlde. Guon fan de tags wurde dellein troch de meiwurkers sels neffens de ynstruksjes, yn it sjabloan allinnich de wichtichste: de kaart tag wurknimmer-kaart, rjochting tag rjochting-belûke en kommando tag team-qa.
As gefolch, nei't elkenien in kaart foar himsels makke hat, wurdt in folsleine tabel mei ynformaasje oer meiwurkers krigen. Dizze ynformaasje kin brûkt wurde op ferskate punten. Resource managers kinne sammelje algemiene tabellen foar harsels, en team leads kinne sammelje kommando tabellen troch in foegjen in team tag oan de seleksje.
By tags kinne jo sjen ferskate gearfettings, bygelyks, troch qa-upgrade-plan alle taken foar QA ûntwikkeling wurdt werjûn. Tagelyk hâldt elke persoan yn syn wurknimmerkaart in wichtich ferhaal en syn eigen ûntwikkelingsplan - hy makket in nêste side út 'e sjabloan foar ûntwikkelingsplannen.
konklúzje
Hâld alle dokumintaasje op sa'n manier dat jo jo der net foar skamje, en brûkers wurde net fergriemd sear!
Ik hoopje echt dat it artikel nuttich sil wêze en oarder sil komme yn alle dokumintaasje fan 'e wrâld.
Boarne: www.habr.com