Sveiki visi!
Mano vardas Maša, dirbu kokybės užtikrinimo inžinieriumi Tinkoff įmonių grupėje. QA darbas apima daug bendravimo su skirtingais žmonėmis iš skirtingų komandų, taip pat buvau edukacinių programų vadovė ir lektorė, todėl mano bendravimo žemėlapis buvo kuo platesnis. Ir kažkuriuo momentu aš sprogau: supratau, kad negaliu, negaliu, negaliu užpildyti pragariškų tonų neįskaitomų lentelių ir dokumentų.
Tikrai kiekvienas iš jūsų dabar įsivaizdavo, apie ką aš kalbu, ir išpylė šaltu prakaitu: pavardžių sąrašai be abėcėlės tvarkos, lentelės su šimtais stulpelių kreivu išdėstymu, lentelės su tūkstančiais eilučių, kuriose reikia nuvalyti pirštą. ant pelės ratuko, kad atrodytų antraštė, tonos puslapių nenumeruotų instrukcijų, šimtai laiškų, išsiųstų vienas kitam su duomenimis, kuriuos reikia išanalizuoti ir susisteminti bei sukrauti į vienodai neįskaitomas lenteles.
Taigi, kai šiek tiek atvėsiau, nusprendžiau parašyti šį straipsnį. Pakalbėsiu apie tai, kaip galite paprastai (net kartais patogiai) tvarkyti įvairią ne gaminio dokumentaciją. Tikiuosi, kad straipsnis pasklis po internetą ir pragaro lygis greta plėtros esančiuose skyriuose bent šiek tiek sumažės, o žmonės (taip pat ir aš) taps šiek tiek laimingesni.
Įrankiai
Produkto dokumentacija dažnai laikoma šalia kodo, o tai yra gerai. O ne gaminių dokumentacija dažniausiai saugoma bet kur. Žmonės dažnai bando perkelti informaciją iš skirtingų vietų į Confluence, ir mes ne išimtis. Taigi likusi istorijos dalis yra apie jį.
Apskritai „Confluence“ yra pažangus wiki variklis. Tai leidžia dirbti su duomenimis įvairių tipų ekranuose: tekstu su formatavimu, lentelėmis, įvairiomis diagramomis. Tai labai įdomus ir galingas įrankis, tačiau jei nežinote, kaip jį paruošti, atsiras dar vienas neįskaitomų dokumentų sąvartynas. Aš išmokysiu tave gaminti!
makrokomandos
Beveik visa „Confluence“ magija kyla iš makrokomandų. Makrokomandų yra daug ir jas galima derinti tarpusavyje. Jos gali būti mokamos arba nemokamos; žemiau bus pateikti įvairūs makrokomandų pavyzdžiai su nuorodomis į jų dokumentaciją.
Darbo su makrokomandomis sąsaja yra kuo paprastesnė. Norėdami pridėti makrokomandą, turite spustelėti pliusą ir iš sąrašo pasirinkti norimą elementą.
Jei makrokomanda yra savarankiška, tai yra, į ją nieko daugiau įterpti nereikia, ji atrodo kaip blokas.
Jei makrokomandai reikia ką nors įdėti, kad ji veiktų, ji atrodo kaip rėmelis.
Tuo pačiu metu į vieną kadrą galite įdėti tiek kitų, kiek norite, jei tik jūsų piramidėje yra logikos.
Kiekviena makrokomanda turi peržiūrą: ji iš karto parodo, ar teisingai užpildėte ir sukonfigūravote makrokomandą.
šablonai
Be makrokomandų, yra patogus išankstinio turinio užpildymo įrankis – šablonas.
Šablonus galima naudoti kuriant bet kurį puslapį: tiesiog spustelėkite tris taškus šalia mygtuko „Sukurti“ ir pasirinkite norimą šabloną.
Tada visas turinys, esantis šablone, bus įtrauktas į sukurtą puslapį.
Kiekvienas gali kurti puslapius iš šablonų, tačiau tai gali daryti tik tie, kurie turi teisę patys kurti ar redaguoti šablonus. Prie šablono galite pridėti papildomų nurodymų, kaip puslapis turi būti prižiūrimas.
Stalų magija
Tiesą sakant, aš, kaip technikos specialistas, labai mėgstu lenteles ir galiu į jas sudėti beveik bet kokią informaciją (nors tai ne visada efektyvu). Pačios lentelės yra aiškios, struktūrizuotos, keičiamo dydžio, stebuklingos!
Tačiau net ir toks nuostabus daiktas kaip stalas gali būti sugadintas. Ir jūs galite sėkmingai jį naudoti ir net patobulinti. Daugiau apie tai žemiau.
Filtravimas (mokamas papildinys)
Bet kokią didžiulę, neįskaitomą lentelę galima padaryti šiek tiek mažesnę ir šiek tiek lengviau skaitomą naudojant filtravimą. Tam galite naudoti mokamą makrokomandą .
Į šią makrokomandą reikia įdėti lentelę (galima net ir bjauriausia, svarbiausia ją nustumti visą). Makrokomandoje galite pasirinkti išskleidžiamojo filtro, teksto, skaičių ir datos filtro stulpelius.
Įsivaizduokite, kad visa informacija apie kandidatus į visas laisvas darbo vietas yra įrašyta į lentelių sąrašą. Natūralu, kad nerūšiuojama – žmonės ateina į pokalbius ne abėcėlės tvarka. Ir jūs turite suprasti, ar anksčiau esate kalbinęs konkretų kandidatą. Jums tereikia įdėti šį pragarą į filtro makrokomandą, pridėti teksto filtrą pagal pavardę – ir voila, informacija yra jūsų ekrane.
Verta paminėti, kad didelių lentelių filtravimas gali turėti įtakos sistemos našumui ir puslapių įkėlimo laikui, todėl didžiulės lentelės įtraukimas į filtrą yra laikinas ramentas; geriau sukurti procesą, kurio metu žmonėms nereikėtų kurti didelių, neįskaitomų lentelių. proceso pavyzdys bus straipsnio pabaigoje).
Rūšiavimas (mokamas papildinys)
Naudojant magišką makrokomandą Taip pat galite nustatyti numatytąjį rūšiavimą bet kuriame stulpelyje ir sunumeruoti eilutes. Arba spustelėkite bet kurį lentelės stulpelį, įterptą į filtro makrokomandą, ir bus rūšiuojama pagal tą stulpelį.
Pavyzdžiui, turite tą pačią lentelę su kandidatais ir turite įvertinti, kiek interviu buvo atlikta per tam tikrą mėnesį – rūšiuokite pagal datą ir džiaukitės.
Pivot lentelės (mokamas papildinys)
Dabar pereikime prie įdomesnio atvejo. Įsivaizduokite, kad jūsų lentelė yra didžiulė ir jums reikia ką nors iš jo apskaičiuoti. Žinoma, galite nukopijuoti jį į „Excel“, apskaičiuoti, ko jums reikia, ir įkelti duomenis atgal į „Confluence“. Ar galite naudoti makrokomandą vieną kartą? ir gauti tą patį rezultatą, tik atnaujintą.
Pavyzdžiui: turite lentelę, kurioje renkami visų darbuotojų duomenys – kur jie yra geografiškai ir kokias pareigas užima. Norint apskaičiuoti, kiek žmonių yra kiekviename mieste, reikia pasirinkti „PivotTable“ makrokomandos eilutę, kurioje kaupiami duomenys (vietovė) ir operacijos tipas (papildymas).
Natūralu, kad galima grupuoti pagal kelis kriterijus vienu metu, galima peržiūrėti visas galimybes .
Diagramos (mokamas papildinys)
Kaip sakiau, ne visi taip mėgsta stalus kaip aš. Deja, dauguma vadovų jų visai nemėgsta. Tačiau visi labai mėgsta ryškių spalvų diagramas.
„Confluence“ kūrėjai apie tai tikrai žinojo (turbūt turi ir viršininkų, kurie mėgsta ataskaitas ir diagramas, kur jie būtų be to). Todėl galite naudoti magišką makrokomandą . Šioje makrokomandoje turite įdėti suvestinę lentelę iš ankstesnės pastraipos ir voila - jūsų pilki nuobodūs duomenys yra gražiai vizualizuoti.
Žinoma, ši makrokomanda taip pat turi nustatymus. Nuorodą į bet kurios makrokomandos dokumentaciją rasite tos makrokomandos redagavimo režimu.
Lengvas agregavimas
Informacija iš ankstesnių pastraipų tikriausiai nebuvo jūsų apreiškimas. Bet dabar jūs tikrai žinote, kaip naudoti makrokomandas, ir galiu pereiti prie įdomesnės straipsnio dalies.
Žymos
Blogai, kai žmonės kaupia informaciją viename nestruktūrizuotame straipsnyje ar didžiulėje lentelėje. Dar blogiau, kai šios informacijos dalys yra ne tik neįskaitomai suformatuotos, bet ir išsklaidytos visoje „Confluence“. Laimei, išsklaidytą informaciją galima surinkti vienoje vietoje. Norėdami tai padaryti, turite naudoti (žymės visiems pažįstamos iš socialinių tinklų).
Prie bet kurio puslapio galite pridėti bet kokį skaičių žymų. Spustelėję žymą pateksite į apibendrinimo puslapį su nuorodomis į visą turinį su ta žyma, taip pat susijusių žymų rinkinį. Susijusios žymos yra tos, kurios dažnai rodomos tame pačiame puslapyje.
Puslapio ypatybės
Galite į puslapį įtraukti kitą įdomią makrokomandą, kad susistemintumėte informaciją - . Jo viduje reikia pateikti lentelę iš dviejų stulpelių, pirmasis bus raktas, o antrasis – turto vertė. Be to, makrokomandą galima paslėpti nuo puslapio, kad ji netrukdytų skaityti turinio, tačiau puslapis vis tiek bus pažymėtas reikalingais klavišais.
Atkreipkite dėmesį į ID – patogu jį nustatyti taip, kad skirtingiems puslapiams būtų priskirtos skirtingos ypatybių grupės (ar net vienam puslapiui skirtingos ypatybių grupės).
ataskaitos
Galite rinkti ataskaitas naudodami žymas. Pavyzdžiui, makro renka visus puslapius su konkrečiu žymų rinkiniu.
Tačiau įdomesnė ataskaita yra makro . Taip pat surenka visus puslapius su tam tikru žymių rinkiniu, bet ne tik parodo jų sąrašą, bet sukuria lentelę (ar pagaunate ryšį su straipsnio pradžia?), kurioje stulpeliai yra puslapis. nuosavybės raktai.
Rezultatas yra suvestinė informacijos iš skirtingų šaltinių lentelė. Smagu, kad turi patogias funkcijas: adaptyvų išdėstymą, rūšiavimą pagal bet kurį stulpelį. Be to, tokią ataskaitų lentelę galima sukonfigūruoti makrokomandoje.
Konfigūruodami galite pašalinti kai kuriuos ataskaitos stulpelius, nustatyti numatytąją būseną arba rodomų įrašų skaičių. Taip pat galite nustatyti puslapio nuosavybės ID, kad matytumėte tik jums reikalingą informaciją.
Pavyzdžiui, turite daug darbuotojo puslapių, šiuose puslapiuose yra aibė savybių apie žmogų: kokio lygio jis yra, kur jis yra, kada jis prisijungė prie komandos ir pan. Šios savybės yra pažymėtos ID = darbuotojo_inf. Tame pačiame puslapyje yra antrasis ypatybių rinkinys, kuriame pateikiama informacija apie asmenį kaip komandos dalį: kokį vaidmenį asmuo atlieka, kokioje komandoje jis yra ir pan. Šios savybės yra pažymėtos ID = komandos_informacija. Tada, sudarant ataskaitą, vienu metu galite rodyti tik vieno ar dviejų ID informaciją – kas patogiau.
Šio požiūrio grožis yra tas, kad kiekvienas gali susikomplektuoti jam reikalingą informacinę lentelę, kuri nieko nedubliuos ir bus atnaujinta atnaujinus pagrindinį puslapį. Pavyzdžiui: komandos vadovui nesvarbu, kada jo kūrėjai įsidarbino, bet svarbu, kokį vaidmenį kiekvienas iš jų atlieka komandoje. Komandos vadovas surinks ataskaitą apie komandą. Ir buhalteriui apskritai nesvarbu, kas kokį vaidmenį atlieka, bet pareigos yra svarbios - jis surašys pareigybių ataskaitą. Tokiu atveju informacijos šaltinis nebus dubliuojamas ar perduotas.
Galutinis procesas
Mokymas
Taigi, naudodami makrokomandas kaip pavyzdį, galime gražiai struktūrizuoti ir efektyviai kaupti informaciją „Confluence“. Tačiau idealiu atveju turite įsitikinti, kad nauja informacija yra nedelsiant struktūrizuota ir patenka į visus jau naudojamus agregavimo mechanizmus.
Čia į pagalbą ateis daugybė makrokomandų ir šablonų. Norėdami priversti žmones kurti naujus puslapius norimu formatu, galite naudoti makrokomandą Sukurti iš šablono. Prie puslapio pridedamas mygtukas, paspaudus sukuriamas naujas puslapis iš jums reikalingo šablono. Taip priverčiate žmones iš karto dirbti tokiu formatu, kokio jums reikia.
Šablone, iš kurio kuriate puslapį, turite iš anksto pridėti etiketes, makrokomandą „Puslapio ypatybės“ ir jums reikalingų ypatybių lentelę. Taip pat rekomenduoju pridėti instrukcijas, kokias reikšmes reikia užpildyti puslapyje ir nuosavybės vertes.
Tada galutinis procesas atrodys taip:
- Jūs sukuriate tam tikro tipo informacijos šabloną.
- Šiame šablone makrokomandoje pridedate etikečių ir puslapio ypatybių.
- Bet kurioje patogioje vietoje sukurkite pagrindinį puslapį su mygtuku, kurį spustelėjus sukuriamas antrinis puslapis iš šablono.
- Leidžiate vartotojams eiti į šakninį puslapį, kuris potencialiai sugeneruos reikiamą informaciją (pagal reikiamą šabloną, paspaudus mygtuką).
- Ataskaitą apie puslapio ypatybes renkate naudodami šablone nurodytas žymas.
- Džiaukitės: visą reikiamą informaciją turite patogiu formatu.
Spąstų
Kaip kokybės inžinierius galiu drąsiai teigti, kad pasaulyje nieko nėra tobulo. Net dieviški stalai yra netobuli. Ir aukščiau minėtame procese yra spąstų.
- Jei nuspręsite pakeisti puslapio ypatybių pavadinimus ar sudėtį, turėsite atnaujinti visus jau sukurtus objektus, kad jų duomenys būtų teisingai įtraukti į suvestinę ataskaitą. Tai liūdna, bet, kita vertus, verčia smulkiai pagalvoti apie savo informacijos rinkinio „architektūrą“, o tai yra labai įdomi užduotis.
- Turėsite parašyti nemažai instrukcijų, kaip pildyti informacines lenteles ir naudoti žymes. Tačiau, kita vertus, šiuo straipsniu galite tiesiog pasiekti reikiamus žmones.
Ne gaminio dokumentacijos saugojimo pavyzdys
Aukščiau aprašytu procesu galite organizuoti beveik bet kokios informacijos saugojimą. Šio požiūrio grožis yra tas, kad jis yra universalus: kai vartotojai prie jo pripranta, jie nustoja kurti netvarką. Dar vienas didelis (bet ne nemokamas) pliusas – galimybė skristi rinkti įvairią statistiką ir pagal ją braižyti gražias diagramas.
Pateiksiu informacijos apie komandą tvarkymo proceso pavyzdį.
Nusprendėme kiekvienam komandos nariui sukurti darbuotojo kortelę. Atitinkamai turime šabloną, pagal kurį kiekvienas naujas žmogus susikuria sau šią kortelę ir joje saugo visą asmeninę informaciją.
Kaip matote, turime išsamią ypatybių lentelę ir iškart pateikiame instrukcijas, kaip tiksliai prižiūrėti šį puslapį. Dalį žymų pagal instrukcijas prideda patys darbuotojai, šablone yra tik pagrindinės: kortelės žyma darbuotojo kortelė, krypties žyma kryptis-įtraukti ir komandos žyma komanda-qa.
Dėl to, kiekvienam susikūrus sau kortelę, gaunama visa lentelė su informacija apie darbuotojus. Šią informaciją galima naudoti įvairiuose taškuose. Išteklių valdytojai gali rinkti bendras lenteles sau, o komandos vadovai gali kurti komandos lenteles, prie pasirinkimo pridėję komandos žymą.
Pavyzdžiui, galite matyti skirtingas santraukas pagal žymas qa-atnaujinimo planas Bus rodomos visos kokybės užtikrinimo kūrimo užduotys. Tuo pačiu kiekvienas žmogus savo darbuotojo kortelėje saugo svarbią istoriją ir savo tobulėjimo planą – sukuria įdėtą puslapį iš plėtros planų šablono.
išvada
Tvarkykite bet kokią dokumentaciją taip, kad nebūtų gėda ir nesukeltumėte nepakeliamo skausmo naudotojams!
Labai tikiuosi, kad straipsnis bus naudingas, o visa pasaulio dokumentacija bus tvarka.
Šaltinis: www.habr.com