Hei kaikille!
Nimeni on Masha, työskentelen laadunvarmistusinsinöörinä Tinkoff-konsernissa. QA-työhön liittyy paljon kommunikointia erilaisten ihmisten kanssa eri tiimeistä, ja olin myös koulutusohjelmien johtajana ja luennoitsijana, joten viestintäkarttani oli mahdollisimman laaja. Ja jossain vaiheessa räjähdin: tajusin, etten voi enää, en voi, en voi täyttää helvetin tonneja lukukelvottomia taulukoita ja asiakirjoja.
Varmasti jokainen teistä nyt kuvitteli, mistä puhun, ja tuli kylmä hiki: sukunimiluettelot ilman aakkosjärjestystä, taulukot, joissa on satoja sarakkeita, joissa on huolimaton asettelu, taulukot, joissa on tuhansia rivejä, joista sinun on pyyhittävä sormesi hiiren rullalla katsoaksesi otsikkoa, tonnia sivuja numeroimattomia ohjeita, satoja kirjeitä, jotka lähetetään toisilleen datan kanssa, jotka on analysoitava ja systematisoitava ja täytettävä samoihin lukukelvottomiin taulukoihin.
Ja niin, kun jäähdytin hieman, päätin kirjoittaa tämän artikkelin. Puhun siitä, kuinka voit normaalisti (jopa joskus kätevästi) ylläpitää erilaisia muita kuin tuotteen asiakirjoja. Toivon, että artikkeli leviää verkossa ja helvetin taso kehityksen viereisillä osastoilla laskee ainakin hieman ja ihmisistä (mukaan lukien minä) tulee hieman onnellisempia.
Työkalut
Tuotedokumentaatiota säilytetään usein koodin rinnalla, mikä on hyvä asia. Ja muuta kuin tuotteen dokumentaatiota säilytetään yleensä missä tahansa. Usein ihmiset yrittävät tuoda tietoa eri paikoista Confluenceen, emmekä me ole poikkeus. Joten tarinan loppuosa on hänestä.
Yleisesti ottaen Confluence on edistynyt wikimoottori. Sen avulla voit käsitellä tietoja eri tyyppisissä näytöissä: teksti muotoilulla, taulukot, erilaiset kaaviot. Tämä on erittäin mielenkiintoinen ja tehokas työkalu, mutta jos et osaa valmistaa sitä, saat toisen kaatopaikan lukukelvottomia asiakirjoja. Minä opetan sinulle ruoanlaittoa!
Makrot
Lähes kaikki Confluencen taika rakentuu makrojen ympärille. Makroja on paljon, ja ne voidaan yhdistää toisiinsa. Ne ovat maksullisia ja ilmaisia, lisäksi siellä on useita esimerkkejä makroista, joissa on linkkejä niiden dokumentaatioon.
Käyttöliittymä makrojen kanssa työskentelyyn on mahdollisimman yksinkertainen. Jos haluat lisätä makron, sinun on napsautettava plus-merkkiä ja valittava haluamasi elementti luettelosta.
Jos makro on omavarainen, eli se ei vaadi sisäänsä jonkin muun lisäämistä, se näyttää lohkolta.
Jos makro tarvitsee jotain sisällään toimiakseen, se näyttää laatikolta.
Samalla voit laittaa niin monta muuta kuin haluat yhden kehyksen sisään, kunhan pyramidissasi on logiikkaa.
Jokaisella makrolla on esikatselu: se näyttää välittömästi, oletko täyttänyt ja määrittänyt makron oikein.
Mallit
Makrojen lisäksi on kätevä työkalu sisällön esitäyttöön - tämä on malli.
Malleja voidaan käyttää luotaessa mitä tahansa sivua: napsauta vain kolmea pistettä "Luo"-painikkeen vieressä ja valitse haluamasi malli.
Sitten kaikki mallissa oleva sisältö lisätään luodulle sivulle.
Kuka tahansa voi luoda sivuja malleista, mutta vain ne, joilla on oikeus luoda tai muokata malleja itse, voivat luoda sivuja. Voit lisätä malliin lisäohjeita sivun ylläpidosta.
Pöydän taikuutta
Itse asiassa teknikkona rakastan taulukoita ja voin kääriä niihin melkein minkä tahansa tiedon (vaikka tämä ei aina ole tehokasta). Itse taulukot ovat selkeitä, jäsenneltyjä, skaalautuvia, maagisia!
Mutta jopa niin upea kokonaisuus kuin pöytä voidaan pilata. Ja sitä voidaan käyttää menestyksekkäästi ja jopa parantaa. Siitä lisää alla.
Suodatus (maksullinen laajennus)
Mistä tahansa valtavasta lukukelvottomasta taulukosta voidaan tehdä hieman pienempikokoinen ja hieman luettavampi suodatuksen avulla. Voit tehdä tämän käyttämällä maksettua makroa .
Tämän makron sisällä sinun täytyy työntää pöytä (jopa rumin on mahdollista, tärkeintä on työntää se kokonaan). Makrossa voit valita sarakkeita avattavalle suodattimelle, tekstisuodattimelle, numero- ja päivämääräsuodattimelle.
Kuvittele, että kaikki tiedot kaikkien avoimien työpaikkojen ehdokkaista tallennetaan taulukkoluetteloon. Luonnollisesti lajittelematta - ihmiset eivät tule haastatteluihin aakkosjärjestyksessä. Ja sinun on ymmärrettävä, oletko haastatellut tiettyä hakijaa aiemmin. Sinun tarvitsee vain laittaa tämä helvetti suodatinmakroon, lisätä tekstisuodatin sukunimen mukaan - ja voila, tiedot ovat näytölläsi.
On syytä huomata, että suurten taulukoiden suodattaminen voi vaikuttaa järjestelmän suorituskykyyn ja sivun latausaikaan, joten suuren taulukon sijoittaminen suodattimeen on väliaikainen haave, on parempi rakentaa prosessi, jossa ihmisten ei tarvitse luoda suuria lukukelvottomia taulukoita ( esimerkki prosessista on artikkelin lopussa).
Lajittelu (maksullinen laajennus)
Magic Macron kanssa Voit myös määrittää oletuslajittelun mille tahansa sarakkeelle ja numeroida rivit. Tai napsauta mitä tahansa taulukon saraketta, joka on lisätty suodatinmakroon, ja lajittelu tapahtuu tämän sarakkeen mukaan.
Sinulla on esimerkiksi sama taulukko hakijoiden kanssa ja sinun on selvitettävä, kuinka monta haastattelua pidettiin tietyssä kuukaudessa - lajittele päivämäärän mukaan ja iloitse.
Pivot-taulukot (maksullinen laajennus)
Siirrytään nyt mielenkiintoisempaan tapaukseen. Kuvittele, että pöytäsi on valtava ja sinun täytyy laskea siitä jotain. Voit tietysti kopioida sen Exceliin, laskea tarvitsemasi tiedot ja ladata tiedot takaisin Confluenceen. Voitko käyttää makroa kerran? ja saat saman tuloksen, vain päivitettynä.
Esimerkiksi: sinulla on taulukko, joka sisältää tiedot kaikista työntekijöistä - missä he sijaitsevat maantieteellisesti ja mitä tehtäviä heillä on. Laskeaksesi kuinka monta ihmistä kussakin kaupungissa on, sinun on valittava "Pivot Table" -makrosta rivi, jolla tiedot kootaan (sijainti) ja toiminnan tyyppi (lisäys).
Luonnollisesti voit ryhmitellä useiden kriteerien mukaan kerralla, näet kaikki mahdollisuudet .
Kaaviot (maksullinen laajennus)
Kuten sanoin, kaikki eivät pidä pöydistä yhtä paljon kuin minä. Valitettavasti useimmat johtajat eivät pidä niistä ollenkaan. Mutta kaikki rakastavat kirkkaita värikarttoja.
Confluencen luojat tiesivät tämän varmasti (heillä on varmasti myös pomoja, jotka rakastavat raportteja ja kaavioita, missä he olisivat ilman sitä). Siksi voit käyttää taikamakroa . Tässä makrossa sinun on asetettava pivot-taulukko edellisestä kappaleesta, ja voila - tylsä harmaa tietosi visualisoituu kauniisti.
Luonnollisesti tässä makrossa on myös asetuksia. Linkki minkä tahansa makron dokumentaatioon löytyy kyseisen makron muokkaustilassa.
Aggregoinnin helppous
Edellisistä kappaleista saadut tiedot eivät luultavasti olleet sinulle ilmestys. Mutta nyt tiedät varmasti kuinka käyttää makroja, ja voin siirtyä artikkelin mielenkiintoisempaan osaan.
Tunnisteet
On huonoa, kun ihmiset tallentavat tietoja yhteen jäsentämättömään artikkeliin tai valtavaan taulukkoon. Vielä pahempaa on, kun osa tästä tiedosta ei ole vain lukukelvoton, vaan myös hajallaan Confluencen laajuuksissa. Onneksi on mahdollista kerätä hajallaan olevaa tietoa yhteen paikkaan. Tätä varten sinun on käytettävä (tunnisteet tutut kaikille sosiaalisissa verkostoissa).
Minkä tahansa määrän tunnisteita voidaan lisätä mille tahansa sivulle. Napsauttamalla tunnistetta siirryt koontisivulle, jossa on linkit kaikkeen kyseisellä tunnisteella varustettuun sisältöön sekä joukko aiheeseen liittyviä tunnisteita. Aiheeseen liittyvät tunnisteet ovat niitä, jotka näkyvät usein samalla sivulla.
Sivun ominaisuudet
Voit lisätä sivulle toisen mielenkiintoisen makron tietojen jäsentämistä varten - . Sen sisällä sinun on lähetettävä kahden sarakkeen taulukko, joista ensimmäinen on avain ja toinen kiinteistön arvo. Lisäksi makro voidaan piilottaa sivulta, jotta se ei häiritse sisällön lukemista, mutta sivu on silti merkitty tarvittavilla näppäimillä.
Kiinnitä huomiota tunnukseen - se on kätevä asettaa ripustamaan eri kiinteistöryhmiä eri sivuille (tai jopa eri kiinteistöryhmiä yhdelle sivulle).
raportit
Tunnisteiden avulla voit kerätä raportteja. Esimerkiksi makro kerää kaikki sivut tietyllä tunnistejoukolla.
Mutta mielenkiintoisempi raportti on makro . Se myös kerää kaikki sivut tietyllä tunnistejoukolla, mutta ei vain luettele niitä, vaan kokoaa taulukon (taltitko yhteyden artikkelin alkuun?), jossa sarakkeet ovat sivun ominaisuuksien avaimia.
Siitä tulee yhteenvetotaulukko tiedoista eri lähteistä. On mukavaa, että siinä on käteviä ominaisuuksia: mukautuva asettelu, lajittelu minkä tahansa sarakkeen mukaan. Myös tällainen raportointitaulukko voidaan konfiguroida makron sisällä.
Kun määrität, voit poistaa raportista joitain sarakkeita, asettaa oletustilan tai näytettävien tietueiden määrän. Voit myös asettaa sivun omaisuuden tunnuksen niin, että näet vain tarvitsemasi tiedot.
Sinulla on esimerkiksi paljon työntekijäsivuja, näillä sivuilla on joukko ominaisuuksia henkilöstä: mikä taso hän on, missä hän on, milloin hän liittyi tiimiin ja niin edelleen. Nämä ominaisuudet on merkitty id = työntekijän_tieto. Ja samalla sivulla on toinen ominaisuusjoukko, joka sisältää tietoja henkilöstä osana tiimiä: mikä rooli henkilö suorittaa, missä tiimissä hän on ja niin edelleen. Nämä ominaisuudet on merkitty ID = team_inf. Sitten raporttia laatiessasi voit näyttää vain yhden tai kahden tunnuksen tiedot kerralla - kumpi on kätevämpää.
Tämän lähestymistavan kauneus on, että jokainen voi kerätä tarvitsemansa tietotaulukon, joka ei kopioi mitään ja päivittyy pääsivun päivityksen yhteydessä. Esimerkiksi: tiiminvetäjä ei välitä milloin hänen kehittäjät saivat työpaikan, vaan on tärkeää, mikä rooli heillä on tiimissä. Ryhmän johtaja kerää raportin ryhmästä. Ja kirjanpitäjä ei välitä kuka tekee mitä roolia, mutta tehtävät ovat tärkeitä - hän kerää raportin tehtävistä. Tässä tapauksessa tietolähdettä ei kopioida tai siirretä.
Viimeinen prosessi
Opetus
Voimme siis kauniisti jäsentää ja koota tietoja Confluencessa käyttämällä makroja esimerkkinä. Ihannetapauksessa sinun on kuitenkin varmistettava, että uusi tieto jäsentyy välittömästi ja pääsee kaikkiin jo käytössä oleviin aggregointimekanismeihin.
Täällä joukko makroja ja malleja tulee apuun. Jos haluat saada ihmiset luomaan uusia sivuja oikeassa muodossa, voit käyttää Luo mallista -makroa. Se lisää sivulle painikkeen, jota napsauttamalla luodaan uusi sivu tarvitsemastasi mallista. Tällä tavalla pakotat ihmiset työskentelemään välittömästi tarvitsemassasi muodossa.
Malliin, josta voit luoda sivun, sinun on lisättävä etukäteen tunnisteet, "Sivun ominaisuudet" -makro ja taulukko tarvitsemistasi ominaisuuksista. Suosittelen myös lisäämään ohjeet millä arvoilla sivu täytetään ja ominaisuusarvot.
Sitten lopullinen prosessi näyttää tältä:
- Olet luomassa mallia tietyntyyppisille tiedoille.
- Lisää tässä mallissa tunnisteita ja sivun ominaisuuksia makroon.
- Luo missä tahansa sopivassa paikassa juurisivu painikkeella, jota napsauttamalla luodaan mallista alisivu.
- Aloita käyttäjien juurisivulta, joka mahdollisesti luo tarvittavat tiedot (halutun mallin mukaan napsauttamalla painiketta).
- Kerää itsellesi raportti sivun ominaisuuksista mallissa määrittämiesi tunnisteiden avulla.
- Iloitse: sinulla on kaikki tarvitsemasi tiedot kätevässä muodossa.
Sudenkuopat
Laatuinsinöörinä voin turvallisesti sanoa, ettei maailmassa ole mitään täydellistä. Jopa jumalalliset pöydät ovat epätäydellisiä. Ja yllä olevassa prosessissa on sudenkuoppia.
- Jos päätät muuttaa sivun ominaisuuksien nimiä tai koostumusta, sinun on päivitettävä kaikki jo luodut objektit, jotta niiden tiedot vedetään oikein yhteenvetoraporttiin. Tämä on surullista, mutta toisaalta se pakottaa sinut pohtimaan yksityiskohtaisesti tietojoukosi "arkkitehtuuria", mikä on erittäin mielenkiintoinen tehtävä.
- Sinun on kirjoitettava kunnollinen määrä ohjeita tietotaulukoiden täyttämiseen ja tunnisteiden käyttöön. Mutta toisaalta, voit vain heittää tämän artikkelin kaikille oikeille ihmisille.
Esimerkki muun kuin tuotteen dokumentaation tallentamisesta
Yllä kuvatun prosessin avulla voit järjestää lähes minkä tahansa tiedon tallennuksen. Lähestymistavan kauneus on, että se on universaali: kun käyttäjät tottuvat siihen, he lakkaavat tekemästä sotkua. Iso (mutta ei ilmainen) plussa on myös mahdollisuus kerätä lennossa erilaisia tilastoja ja piirtää niihin kauniita kaavioita.
Annan esimerkin prosessista, jolla ylläpidetään tietoja joukkueesta.
Jokaiselle tiimin jäsenelle päätimme luoda työntekijäkortin. Sen mukaisesti meillä on malli, jonka mukaan jokainen uusi henkilö luo itselleen tämän kortin ja säilyttää siinä kaikki henkilökohtaiset tietonsa.
Kuten näet, meillä on yksityiskohtainen ominaisuustaulukko ja heti ohjeet tämän sivun ylläpitoon. Osa tunnisteista on työntekijöiden itse kiinnitetty ohjeiden mukaan, mallissa vain tärkeimmät: korttilappu työntekijäkortti, suuntamerkki suunta-osallistua ja komentotunniste joukkue-qa.
Tämän seurauksena, kun jokainen on luonut itselleen kortin, saadaan täydellinen taulukko työntekijöiden tiedoista. Näitä tietoja voidaan käyttää eri kohdissa. Resurssipäälliköt voivat kerätä yleisiä taulukoita itselleen, ja ryhmänjohtajat voivat kerätä komentotaulukoita lisäämällä valintaan tiimitunnisteen.
Tunnisteiden mukaan näet erilaisia yhteenvetoja, esimerkiksi mukaan qa-päivityssuunnitelma kaikki laadunvarmistuksen kehittämistehtävät näkyvät. Samalla jokainen työntekijäkorttinsa henkilö pitää tärkeän tarinan ja oman kehityssuunnitelmansa - hän luo sisäkkäisen sivun kehittämissuunnitelmien mallipohjasta.
Johtopäätös
Säilytä kaikki asiakirjat niin, että et häpeä sitä, eivätkä käyttäjät loukkaannu tuskallisesti!
Toivon todella, että artikkelista on hyötyä ja järjestystä tulee kaikkeen maailman dokumentaatioon.
Lähde: will.com