Hola a todos!
Nire izena Masha da, Tinkoff enpresa taldean kalitatea bermatzeko ingeniari gisa lan egiten dut. QA lanak talde ezberdinetako pertsona ezberdinekin komunikazio asko eskatzen du, eta hezkuntza programen arduradun eta irakasle ere izan nintzen, beraz, nire komunikazio mapa ahalik eta zabalena zen. Eta noizbait eztanda egin nuen: konturatu nintzen ezin dudala, ezin dudala, ezin ditudala bete irakurgaitzezko taula eta dokumentu mordoa.
Segur aski zuetako bakoitzak orain imajinatu duzu zertaz ari naizen eta izerdi hotzean lehertu da: ordena alfabetikorik gabeko abizen zerrendak, ehunka zutabe dituzten taulak trazadura okertuta, hatza garbitu behar duten milaka lerro dituzten taulak. saguaren gurpilean goiburua ikusteko, zenbakirik gabeko jarraibideen orrialde tonaka, elkarri bidalitako ehunka gutun aztertu eta sistematizatu eta berdin irakurezin tauletan sartu beharreko datuekin.
Eta horrela, pixka bat hoztu nintzenean, artikulu hau idaztea erabaki nuen. Produktukoak ez diren hainbat dokumentazio normalean (batzuetan komeni bada ere) nola mantendu ditzakezun hitz egingo dut. Espero dut artikulua Interneten zehar hedatuko dela eta garapenaren ondoko sailetan infernu maila pixka bat gutxitzea gutxienez eta jendea (ni barne) apur bat zoriontsuagoa izatea.
Tresnak
Produktuen dokumentazioa kodearen ondoan gordetzen da askotan, eta hori ona da. Eta produktua ez den dokumentazioa edonon gordetzen da normalean. Jendea askotan saiatzen da informazioa leku ezberdinetatik Confluencera eramaten, eta gu ez gara salbuespena. Beraz, gainerako istorioa berari buruzkoa da.
Oro har, Confluence wiki motor aurreratu bat da. Hainbat pantaila motatako datuekin lan egiteko aukera ematen du: testua formatuarekin, taulak, hainbat grafiko. Oso tresna interesgarria eta indartsua da hau, baina ez badakizu nola prestatu, irakurri ezin diren dokumentuen beste isurketa batekin amaituko duzu. Sukaldatzen irakatsiko dizut!
Makroak
Confluenceren magia ia guztia makroetatik dator. Makro asko daude, eta elkarren artean konbina daitezke. Ordainpekoak edo doakoak izan daitezke; behean makroen hainbat adibide egongo dira haien dokumentaziorako estekekin.
Makroekin lan egiteko interfazea ahalik eta sinpleena da. Makro bat gehitzeko, plusan klik egin eta zerrendatik nahi duzun elementua hautatu behar duzu.
Makro bat autonomoa bada, hau da, ez du behar bere baitan beste ezer txertatzea, bloke baten itxura du.
Makro batek barruan zerbait jarri behar badu funtziona dezan, marko baten itxura du.
Aldi berean, nahi adina beste fotograma baten barruan jar ditzakezu, betiere zure piramidean logika badago.
Makro bakoitzak aurrebista bat du: berehala erakusten du makroa behar bezala bete eta konfiguratu duzun ala ez.
txantiloiak
Makroez gain, edukia aurrez betetzeko tresna eroso bat dago: txantiloia.
Txantiloiak erabil daitezke edozein orrialde sortzerakoan: "Sortu" botoiaren ondoan dauden hiru puntuetan klik egin eta nahi duzun txantiloia aukeratu besterik ez dago.
Ondoren txantiloian dagoen eduki guztia gehituko da sortutako orrialdera.
Edonork sor ditzake orriak txantiloietatik, baina txantiloiak beraiek sortzeko edo editatzeko eskubideak dituztenek bakarrik egin ditzakete. Jarraibide gehigarriak gehi ditzakezu txantiloiari orria nola mantendu behar den jakiteko.
Mahaien magia
Egia esan, teknikari gisa, izugarri maite ditut taulak eta ia edozein informazio bil ditzaket (nahiz eta hori ez den beti eraginkorra). Taulak argiak, egituratuak, eskalagarriak, magikoak dira!
Baina mahai bat bezalako entitate zoragarria ere hondatu daiteke. Eta arrakastaz erabil dezakezu eta hobetu ere egin dezakezu. Honi buruz gehiago behean.
Iragazkia (ordainpeko plugina)
Edozein taula erraldoi eta irakurgaitza egin daiteke iragazkia erabiliz. Ordaindutako makro bat erabil dezakezu horretarako .
Makro honen barruan mahai bat jarri behar duzu (ahal den itsusiena ere, gauza nagusia bere osotasunean bultzatzea da). Makroan, goitibeherako iragazkia, testu-iragazkia, zenbaki-iragazkia eta data-iragazkia zutabeak hauta ditzakezu.
Imajinatu hutsik dauden lanpostu guztietarako hautagaiei buruzko informazio guztia taula zerrenda batean jasotzen dela. Jakina, sailkatu gabe - jendea elkarrizketetara etortzen da ez ordena alfabetikoan. Eta aurretik eskatzaile zehatz bat elkarrizketatu duzun ala ez ulertu behar duzu. Infernu hau iragazki makro batean jarri besterik ez duzu behar, gehitu testu-iragazkia abizenaren arabera - eta listo, informazioa zure pantailan dago.
Azpimarratzekoa da taula erraldoiak iragazteak sistemaren errendimenduan eta orriak kargatzeko denboran eragina izan dezakeela, beraz, taula handi bat iragazki batean jartzea aldi baterako makulua da; hobe da prozesu bat eraikitzea, non jendeak ez dituen taula erraldoi eta irakurezinak sortu behar (bat prozesuaren adibidea artikuluaren amaieran egongo da).
Sailkatzea (ordainpeko plugina)
Makro magiko bat erabiliz Edozein zutabetan ordena lehenetsia ere ezar dezakezu eta errenkadak zenbakitu. Edo egin klik iragazki makroan txertatutako taularen edozein zutabetan, eta zutabe horren arabera ordenatuko da.
Esate baterako, eskatzaileekin taula bera duzu eta hilabete jakin batean zenbat elkarrizketa egin diren kalkulatu behar duzu, dataren arabera ordenatu eta pozik egon.
Taula dinamikoak (ordainpeko plugina)
Orain pasa gaitezen kasu interesgarriago batera. Imajinatu zure mahaia handia dela eta hortik zerbait kalkulatu behar duzula. Noski, Excel-en kopiatu dezakezu, behar duzuna kalkulatu eta datuak berriro Confluence-ra igo ditzakezu. Erabili al dezakezu makroa behin? eta emaitza bera lortu, eguneratuta soilik.
Adibidez: langile guztien datuak biltzen dituen taula bat duzu: geografikoki non dauden eta zer kargu betetzen dituzten. Hiri bakoitzean zenbat pertsona dauden kalkulatzeko, datuak (kokapena) eta eragiketa mota (gehitzea) biltzen dituen taula dinamikoko makroaren errenkada hautatu behar duzu.
Jakina, hainbat irizpideren arabera taldeka zaitezke aldi berean, aukera guztiak ikus daitezke .
Diagramak (ordainpeko plugina)
Esan bezala, denek ez dituzte mahaiak nik bezainbeste maite. Zoritxarrez, zuzendari gehienei ez zaizkie batere gustatzen. Baina denek maite dituzte kolore biziko diagramak.
Confluenceren sortzaileek, zalantzarik gabe, bazekiten horren berri (ziurrenik txostenak eta diagramak maite dituzten nagusiak ere badituzte, non egongo lirateke hori gabe). Hori dela eta, makro magikoa erabil dezakezu . Makro honetan aurreko paragrafoko taula dinamikoa jarri behar duzu, eta listo - zure datu aspergarri grisak ederki ikusten dira.
Jakina, makro honek ezarpenak ere baditu. Edozein makroren dokumentaziorako esteka makro horren edizio moduan aurki daiteke.
Agregazio erraza
Aurreko paragrafoetako informazioa ziurrenik ez zen zuretzat errebelazio bat izan. Baina orain, zalantzarik gabe, badakizu makroak nola erabiltzen diren, eta artikuluaren zati interesgarrienera pasa naiteke.
Tags
Txarra da jendeak informazioa egituratu gabeko artikulu batean edo taula handi batean gordetzen duenean. Are okerragoa da informazio horren zatiak irakurgaitz formatua izateaz gain, Confluencen zehar sakabanatuta daudenean. Zorionez, leku bakarrean sakabanatuta dagoen informazioa biltzea posible da. Horretarako erabili behar duzu (sare sozialetako guztientzako ezagunak diren etiketak).
Edozein orrialdetan etiketa kopuru bat gehi dezakezu. Etiketa batean klik eginez gero, etiketa hori duten eduki guztietarako estekak dituen agregazio orri batera eramango zaitu, baita erlazionatutako etiketa multzo batera ere. Erlazionatutako etiketak orrialde berean maiz agertzen direnak dira.
Orriaren propietateak
Orriari beste makro interesgarri bat gehi diezaiokezu informazioa egituratzeko - . Haren barruan bi zutabeko taula aurkeztu behar duzu, lehenengoa gakoa izango da, eta bigarrena jabetzaren balioa. Gainera, makroa orrialdetik ezkutatu daiteke edukia irakurtzeko oztoporik izan ez dezan, baina orria beharrezko gakoekin markatuta egongo da oraindik.
Erreparatu IDari: komenigarria da orri ezberdinei propietate talde desberdinak esleitzeko (edo orrialde bati ere propietate talde desberdinak).
Txostenak
Etiketak erabiliz txostenak bil ditzakezu. Adibidez, makroa etiketa multzo zehatz batekin orrialde guztiak biltzen ditu.
Baina txosten interesgarriagoa makroa da . Etiketa-multzo jakin bat duten orrialde guztiak ere biltzen ditu, baina ez du horien zerrenda soilik bistaratzen, taula bat sortzen du (artikuluaren hasierarekin loturarik atzematen al duzu?), zeinetan zutabeak orrialdea diren. jabetza-giltzak.
Emaitza iturri ezberdinetako informazioaren laburpen-taula bat da. Polita da funtzio erosoak dituela: diseinu moldagarria, edozein zutaberen arabera ordenatzea. Gainera, txosten-taula hori makro baten barruan konfigura daiteke.
Konfiguratzean, zutabe batzuk kendu ditzakezu txostenetik, egoera lehenetsi bat edo bistaratzen diren erregistro kopurua ezarri. Orriaren jabetza IDa ere ezar dezakezu behar duzun informazioa soilik ikusteko.
Adibidez, langileen orrialde asko dituzu, orrialde hauek pertsonari buruzko propietate multzo bat dute: zer maila dagoen, non dagoen, noiz sartu zen taldean, etab. Propietate hauek markatuta daude ID = langile_inf. Eta orrialde berean bigarren propietate multzo bat dago, eta bertan pertsonari buruzko informazioa taldean dago: pertsona horrek zer rol betetzen duen, zein taldetan dagoen, etab. Propietate hauek markatuta daude ID = talde_inf. Ondoren, txosten bat osatzerakoan, identifikazio baten edo biren informazioa soilik bistaratu dezakezu aldi berean, erosoena dena.
Planteamendu honen edertasuna da bakoitzak behar duen informazio-taula munta dezakeela, ez du ezer bikoiztuko eta orri nagusia eguneratzen denean eguneratuko da. Adibidez: ez dio axola talde-buru bati bere garatzaileek lana lortzen dutenean, baina garrantzitsua da haietako bakoitzak zein rol jokatzen duen taldean. Taldeburuak taldeari buruzko txosten bat jasoko du. Eta kontulariari, oro har, ez zaio axola nork betetzen duen zer rol, baina posizioak garrantzitsuak dira - posizioei buruzko txostena egingo du. Kasu honetan, informazio iturria ez da bikoiztu edo transferitu egingo.
Azken prozesua
Instrukzio
Beraz, ederki egituratu eta eraginkortasunez batu dezakegu informazioa Confluence-n makroak adibide gisa erabiliz. Baina, hoberena, ziurtatu behar duzu informazio berria berehala egituratzen dela eta dagoeneko erabiltzen diren agregazio-mekanismo guztietan sartzen dela.
Hona hemen makro eta txantiloi mordoa erreskatatzera. Jendea nahi den formatuan orrialde berriak sortzera behartzeko, Sortu txantiloitik makroa erabil dezakezu. Orriari botoi bat gehitzen dio, sakatzean, behar duzun txantiloitik orri berri bat sortzen da. Horrela jendea behartzen duzu berehala behar duzun formatuan lan egitera.
Orrialde bat sortzen duzun txantiloian, etiketak, "Orriaren propietateak" makroa eta behar dituzun propietateen taula gehitu behar dituzu aldez aurretik. Era berean, orrialdean zer balio bete behar diren eta propietateen balioei buruzko argibideak gehitzea gomendatzen dut.
Ondoren, azken prozesua honela izango da:
- Informazio mota zehatz baterako txantiloi bat sortzen duzu.
- Txantiloi honetan etiketak eta orriaren propietateak gehitzen dituzu makro batean.
- Edozein lekutan, sortu erro-orri bat botoi batekin, txantiloitik haur-orri bat sortzen duen klik eginez.
- Erabiltzaileak erro-orrira joaten uzten diezu, beharrezko informazioa sortuko baitute (beharrezko txantiloiaren arabera, botoi batean klik eginez).
- Orriaren propietateei buruzko txosten bat biltzen duzu txantiloian zehaztu dituzun etiketak erabiliz.
- Poztu: beharrezko informazio guztia duzu formatu egoki batean.
Pitfalls
Kalitatezko ingeniari gisa, seguru esan dezaket ezer ez dela perfektua munduan. Jainkozko mahaiak ere inperfektuak dira. Eta goiko prozesuan tranpak daude.
- Orriaren propietateen izenak edo konposizioa aldatzea erabakitzen baduzu, dagoeneko sortutako objektu guztiak eguneratu beharko dituzu, haien datuak laburpen-txostenean behar bezala sartu daitezen. Tristea da hori, baina, bestalde, zure informazio multzoaren “arkitektura” zehatz-mehatz pentsatzera behartzen zaitu, oso lan interesgarria baita.
- Informazio-taulak bete eta etiketak erabiltzeko argibide dezente idatzi beharko dituzu. Baina bestetik, artikulu honekin pertsona egokiak jo ditzakezu.
Produktukoak ez diren dokumentazioa gordetzeko adibidea
Goian deskribatutako prozesuaren bidez, ia edozein informazio biltegiratzea antola dezakezu. Planteamenduaren edertasuna unibertsala dela da: erabiltzaileak ohitzen direnean, nahaspila sortzeari uzten diote. Beste abantaila handi bat (baina ez doakoa) hainbat estatistika hegan biltzeko eta horietan oinarritutako diagrama ederrak marrazteko gaitasuna da.
Talde bati buruzko informazioa mantentzeko gure prozesuaren adibide bat emango dizut.
Taldeko pertsona bakoitzarentzat langile txartela sortzea erabaki genuen. Horren arabera, txantiloi bat dugu, zeinaren arabera pertsona berri bakoitzak bere kabuz sortzen duen txartel hori eta bertan informazio pertsonal guztia gordetzen du.
Ikus dezakezunez, propietateen taula zehatza dugu eta berehala orrialde hau nola mantendu behar den argibideak ditugu. Etiketa batzuk langileek eurek gehitzen dituzte argibideen arabera; txantiloiak nagusiak baino ez ditu: txartelaren etiketa langile-txartela, norabide etiketa norabide-inplikatu eta taldearen etiketa talde-qa.
Ondorioz, bakoitzak bere kabuz txartel bat sortu ostean, langileei buruzko informazioa jasotzen duen taula oso bat lortzen da. Informazio hori hainbat puntutan erabil daiteke. Baliabideen kudeatzaileek taula orokorrak bil ditzakete beren kabuz, eta talde arduradunek talde-taulak sor ditzakete aukeraketari talde etiketa bat gehituta.
Etiketen arabera laburpen desberdinak ikus ditzakezu, adibidez qa-berritze-plana QA garapen-zeregin guztiak bistaratuko dira. Aldi berean, pertsona bakoitzak historia garrantzitsu bat eta bere garapen-plana gordetzen ditu bere langile-txartelean - garapen planen txantiloitik habiaratutako orri bat sortzen du.
Ondorioa
Mantendu edozein dokumentazio horretan lotsarik ez dagoen moduan, eta erabiltzaileei ez die min izugarririk eragiten!
Benetan espero dut artikulua erabilgarria izatea eta ordena munduko dokumentazio guztietara iritsiko dela.
Iturria: www.habr.com