Saluton ĉiuj!
Mi nomiĝas Masha, mi laboras kiel inĝeniero pri kvalito-certigo ĉe la Tinkoff-grupo de kompanioj. QA laboro implikas multan komunikadon kun malsamaj homoj de malsamaj teamoj, kaj mi ankaŭ estis administranto kaj preleganto de edukaj programoj, do mia komunika mapo estis kiel eble plej larĝa. Kaj iam mi eksplodis: mi konstatis, ke mi ne povas, mi ne povas, mi ne povas plenigi inferajn tunojn da nelegeblaj tabeloj kaj dokumentoj.
Verŝajne ĉiu el vi nun imagis, pri kio mi parolas, kaj eksplodis en malvarma ŝvito: listoj de familiaj nomoj sen alfabeta ordo, tabeloj kun centoj da kolumnoj kun kurba aranĝo, tabeloj kun miloj da linioj, en kiuj oni bezonas viŝi la fingron. sur la musrado por rigardi kaplinion, tunojn da paĝoj de sennumeritaj instrukcioj, centojn da leteroj senditaj unu al la alia kun datumoj, kiujn oni devas analizi kaj sistemigi kaj plenigi en same nelegeblajn tabelojn.
Kaj do, kiam mi iomete malvarmiĝis, mi decidis skribi ĉi tiun artikolon. Mi parolos pri kiel vi povas normale (eĉ foje oportune) konservi diversajn neproduktajn dokumentojn. Mi esperas, ke la artikolo disvastiĝos tra la Interreto kaj la nivelo de infero en la fakoj najbaraj al la evoluo almenaŭ iomete malpliiĝos, kaj homoj (inkluzive de mi) fariĝos iom pli feliĉaj.
Iloj
Produktdokumentado ofte estas konservita apud la kodo, kio estas bona afero. Kaj neprodukta dokumentaro estas kutime stokita ie ajn. Homoj ofte provas movi informojn de malsamaj lokoj en Confluence, kaj ni ne estas escepto. Do la resto de la rakonto temas pri li.
Ĝenerale, Confluence estas altnivela vikia motoro. Ĝi permesas vin labori kun datumoj en malsamaj specoj de ekrano: teksto kun formatado, tabeloj, diversaj diagramoj. Ĉi tio estas tre interesa kaj potenca ilo, sed se vi ne scias kiel prepari ĝin, tiam vi finos kun alia rubejo de nelegeblaj dokumentoj. Mi instruos vin kiel kuiri!
Makrooj
Preskaŭ ĉio el la magio de Confluence venas de makrooj. Estas multaj makrooj, kaj ili povas esti kombinitaj unu kun la alia. Ili povas esti pagitaj aŭ senpagaj; malsupre estos diversaj ekzemploj de makrooj kun ligiloj al dokumentado por ili.
La interfaco por labori kun makrooj estas kiel eble plej simpla. Por aldoni makroon, vi devas alklaki la pluson kaj elekti la deziratan elementon el la listo.
Se makroo estas memstara, tio estas, ĝi ne postulas enmeti ion alian en si mem, ĝi aspektas kiel bloko.
Se makroo postulas ion meti en ĝi por ke ĝi funkciu, ĝi aspektas kiel kadro.
Samtempe, vi povas meti tiom da aliaj kiom vi volas ene de unu kadro, kondiĉe ke ekzistas logiko en via piramido.
Ĉiu makroo havas antaŭrigardon: ĝi tuj montras ĉu vi plenigis kaj agordis la makroon ĝuste.
Skemoj
Krom makrooj, ekzistas oportuna ilo por antaŭplenigi enhavon - ŝablono.
Ŝablonoj povas esti uzataj dum kreado de ajna paĝo: simple alklaku la tri punktojn apud la butono "Krei" kaj elektu la deziratan ŝablonon.
Tiam la tuta enhavo kiu estas en la ŝablono estos aldonita al la kreita paĝo.
Ĉiu povas krei paĝojn el ŝablonoj, sed nur tiuj, kiuj havas la rajtojn krei aŭ redakti la ŝablonojn mem, povas fari tion. Vi povas aldoni pliajn instrukciojn al la ŝablono pri kiel la paĝo devas esti prizorgata.
La magio de tabloj
Fakte, kiel teknikisto, mi tre amas tabelojn kaj povas envolvi preskaŭ ajnan informon en ili (kvankam ĉi tio ne ĉiam efikas). La tabloj mem estas klaraj, strukturitaj, skaleblaj, magiaj!
Sed eĉ tia mirinda ento kiel tablo povas esti ruinigita. Kaj vi povas sukcese uzi ĝin kaj eĉ plibonigi ĝin. Pli pri ĉi tio sube.
Filtrado (pagita kromaĵo)
Ajna grandega, nelegebla tabelo povas esti iom malpli grandega kaj iom pli legebla per filtrado. Vi povas uzi pagitan makroon por ĉi tio .
Vi devas meti tablon ene de ĉi tiu makroo (eĉ la plej malbela eblas, la ĉefa afero estas puŝi ĝin en ĝia tuteco). En la makroo, vi povas elekti kolumnojn por la falfiltrilo, tekstfiltrilo, nombra filtrilo kaj data filtrilo.
Nur imagu, ke ĉiuj informoj pri kandidatoj por ĉiuj vakantaĵoj estas registritaj en tabela listo. Nature, neordigite - homoj venas al intervjuoj ne en alfabeta ordo. Kaj vi devas kompreni ĉu vi antaŭe intervjuis specifan kandidaton. Vi nur bezonas meti ĉi tiun inferon en filtrilan makroon, aldoni tekstan filtrilon laŭ familia nomo - kaj voila, la informoj estas sur via ekrano.
Indas noti, ke filtri grandegajn tabelojn povas influi sisteman rendimenton kaj paĝajn ŝarĝtempojn, do meti grandegan tabelon en filtrilon estas provizora lambastono; estas pli bone konstrui procezon en kiu homoj ne devas krei grandegajn, nelegeblajn tabelojn ( ekzemplo de la procezo estos ĉe la fino de la artikolo).
Ordigo (pagita kromaĵo)
Uzante magian makroon Vi ankaŭ povas agordi la defaŭltan ordigon sur iu ajn kolumno kaj numeri la vicojn. Aŭ alklaku iun ajn kolumnon de la tabelo enigita en la filtrila makroo, kaj ordigo okazos laŭ tiu kolumno.
Ekzemple, vi havas la saman tabelon kun kandidatoj kaj vi devas taksi kiom da intervjuoj estis faritaj en certa monato - ordigu laŭ dato kaj estu feliĉa.
Pivotaj tabeloj (pagita kromaĵo)
Nun ni transiru al pli interesa kazo. Imagu, ke via tablo estas grandega kaj vi devas kalkuli ion el ĝi. Kompreneble, vi povas kopii ĝin en Excel, kalkuli kion vi bezonas kaj alŝuti la datumojn reen al Confluence. Ĉu vi povas uzi la makroon unufoje? kaj ricevu la saman rezulton, nur ĝisdatigita.
Ekzemple: vi havas tabelon, kiu kolektas datumojn de ĉiuj dungitoj - kie ili geografie situas kaj kiajn postenojn ili okupas. Por kalkuli kiom da homoj estas en ĉiu urbo, vi devas elekti la vicon en la PivotTable makroo kiu agregas la datumojn (loko) kaj operacio tipo (aldono).
Nature, vi povas grupiĝi laŭ pluraj kriterioj samtempe, ĉiuj eblecoj estas videblaj .
Furorlisto (pagita kromaĵo)
Kiel mi diris, ne ĉiuj amas tablojn tiom kiom mi. Bedaŭrinde, plej multaj administrantoj tute ne ŝatas ilin. Sed ĉiuj vere amas brilkolorajn diagramojn.
La kreintoj de Confluence certe sciis pri tio (ili verŝajne ankaŭ havas estrojn kiuj amas raportojn kaj diagramojn, kie ili estus sen ĝi). Tial vi povas uzi la magian makroon . En ĉi tiu makroo vi devas meti la pivottabelon de la antaŭa alineo, kaj voila - viaj grizaj enuigaj datumoj estas bele bildigitaj.
Kompreneble, ĉi tiu makroo ankaŭ havas agordojn. Ligo al la dokumentado por iu makroo troviĝas en la redakta reĝimo de tiu makroo.
Facila agregado
La informoj de la antaŭaj alineoj verŝajne ne estis revelacio por vi. Sed nun vi certe scias kiel uzi makroojn, kaj mi povas pluiri al la pli interesa parto de la artikolo.
Etikedoj
Estas malbone kiam homoj konservas informojn en unu senstruktura artikolo aŭ grandega tabelo. Estas eĉ pli malbone kiam partoj de ĉi tiu informo estas ne nur nelegebla formatita, sed ankaŭ disvastigitaj tra Confluence. Feliĉe, eblas kolekti disajn informojn en unu loko. Por fari tion vi devas uzi (etikedoj konataj al ĉiuj el sociaj retoj).
Vi povas aldoni ajnan nombron da etikedoj al iu ajn paĝo. Klako sur etikedo kondukos vin al agregacia paĝo kun ligiloj al ĉiu enhavo kun tiu etikedo, kaj ankaŭ aro da rilataj etikedoj. Rilataj etikedoj estas tiuj, kiuj aperas ofte sur la sama paĝo.
Paĝaj propraĵoj
Vi povas aldoni alian interesan makroon al la paĝo por strukturi informojn - . En ĝi vi devas sendi tabelon de du kolumnoj, la unua estos la ŝlosilo, kaj la dua estos la valoro de la posedaĵo. Krome, la makroo povas esti kaŝita de la paĝo, por ke ĝi ne malhelpas la legadon de la enhavo, sed la paĝo ankoraŭ estos markita per la necesaj klavoj.
Atentu la ID - estas oportune agordi ĝin por atribui malsamajn grupojn de propraĵoj al malsamaj paĝoj (aŭ eĉ malsamaj grupoj de propraĵoj al unu paĝo).
Raportoj
Vi povas kolekti raportojn uzante etikedojn. Ekzemple, makroo kolektas ĉiujn paĝojn kun specifa aro de etikedoj.
Sed pli interesa raporto estas la makroo . Ĝi ankaŭ kolektas ĉiujn paĝojn kun certa aro da etikedoj, sed ĝi ne nur montras liston de ili, sed kreas tabelon (ĉu vi kaptas la ligon kun la komenco de la artikolo?), en kiu la kolumnoj estas la paĝo. posedŝlosiloj.
La rezulto estas resuma tabelo de informoj de malsamaj fontoj. Estas agrable, ke ĝi havas oportunajn funkciojn: adapta aranĝo, ordigo laŭ iu ajn kolumno. Ankaŭ tia raporta tabelo povas esti agordita ene de makroo.
Dum agordo, vi povas forigi kelkajn kolumnojn de la raporto, agordi defaŭltan staton aŭ la nombron da rekordoj montritaj. Vi ankaŭ povas agordi la paĝan posedaĵon ID por vidi nur la informojn, kiujn vi bezonas.
Ekzemple, vi havas multajn dungitajn paĝojn, ĉi tiuj paĝoj havas aron da propraĵoj pri la persono: kia nivelo li estas, kie li estas, kiam li aliĝis al la teamo, ktp. Ĉi tiuj propraĵoj estas markitaj ID = dungito_inf. Kaj estas dua aro de propraĵoj sur la sama paĝo, kiu enhavas informojn pri la persono kiel parto de la teamo: kian rolon la persono ludas, en kia teamo li estas, ktp. Ĉi tiuj propraĵoj estas markitaj ID = team_inf. Tiam, kiam vi kompilas raporton, vi povas montri nur informojn pri unu aŭ du identigiloj samtempe - kiu ajn estas pli oportuna.
La beleco de ĉi tiu aliro estas, ke ĉiuj povas kunmeti la informan tabelon, kiun ili bezonas, kiu ne duobligos ion kaj estos ĝisdatigita kiam la ĉefpaĝo estos ĝisdatigita. Ekzemple: al teamestro ne gravas kiam liaj programistoj ricevis laboron, sed gravas, kian rolon ĉiu el ili ludas en la teamo. La teamestro kolektos raporton pri la teamo. Kaj la librotenisto ĝenerale ne zorgas, kiu plenumas kian rolon, sed la postenoj estas gravaj - li kompilos raporton pri la postenoj. En ĉi tiu kazo, la fonto de informoj ne estos duobligita aŭ transdonita.
Fina procezo
Instrukcioj
Do, ni povas bele strukturi kaj efike kunigi informojn en Confluence uzante makroojn kiel ekzemplon. Sed ideale, vi devas certigi, ke novaj informoj estas tuj strukturitaj kaj falas en ĉiujn agregajn mekanismojn jam uzatajn.
Jen kie amaso da makrooj kaj ŝablonoj venos al la savo. Por devigi homojn krei novajn paĝojn en la dezirata formato, vi povas uzi la makroon Krei el Ŝablono. Ĝi aldonas butonon al la paĝo, kiam oni klakas, nova paĝo estas kreita el la ŝablono, kiun vi bezonas. Tiel vi devigas homojn tuj labori en la formato kiun vi bezonas.
En la ŝablono el kiu vi kreas paĝon, vi devas aldoni etikedojn, makroon "Paĝaj Propraĵoj" kaj tabelon de la propraĵoj, kiujn vi bezonas. Mi ankaŭ rekomendas aldoni instrukciojn pri kiaj valoroj devas esti plenigitaj en la paĝo kaj posedaĵvaloroj.
Tiam la fina procezo aspektos jene:
- Vi kreas ŝablonon por specifa speco de informoj.
- En ĉi tiu ŝablono vi aldonas etikedojn kaj paĝajn ecojn en makroo.
- En iu ajn oportuna loko, kreu radikan paĝon per butono, alklakante kiu kreas infanan paĝon el la ŝablono.
- Vi lasas uzantojn iri al la radika paĝo, kiu eble generos la necesajn informojn (laŭ la bezonata ŝablono, alklakante butonon).
- Vi kolektas raporton pri la paĝaj propraĵoj uzante la etikedojn, kiujn vi specifis en la ŝablono.
- Ĝoju: vi havas ĉiujn necesajn informojn en oportuna formato.
enfaliloj
Kiel kvalita inĝeniero, mi povas sekure diri, ke nenio estas perfekta en la mondo. Eĉ diaj tabloj estas neperfektaj. Kaj estas malfacilaĵoj en ĉi-supra procezo.
- Se vi decidas ŝanĝi la nomojn aŭ komponadon de paĝaj propraĵoj, vi devos ĝisdatigi ĉiujn jam kreitajn objektojn por ke iliaj datumoj estu ĝuste inkluzivitaj en la resuma raporto. Ĉi tio estas malĝoja, sed, aliflanke, ĝi devigas vin detale pensi pri la "arkitekturo" de via informaro, kio estas tre interesa tasko.
- Vi devos skribi sufiĉe da instrukcioj pri kiel plenigi informajn tabelojn kaj uzi etikedojn. Sed aliflanke, vi povas simple bati ĉiujn ĝustajn homojn per ĉi tiu artikolo.
Ekzemplo de stokado de neprodukta dokumentaro
Per la procezo priskribita supre, vi povas organizi la stokadon de preskaŭ ajna informo. La beleco de la aliro estas, ke ĝi estas universala: post kiam uzantoj alkutimiĝas, ili ĉesas generi malordon. Alia granda (sed ne senpaga) pluso estas la kapablo kolekti diversajn statistikojn sur la flugo kaj desegni belajn diagramojn bazitajn sur ili.
Mi donu al vi ekzemplon de nia procezo por konservi informojn pri teamo.
Ni decidis krei dungitan karton por ĉiu persono en la teamo. Sekve, ni havas ŝablonon laŭ kiu ĉiu nova persono kreas ĉi tiun karton por si kaj konservas ĉiujn personajn informojn en ĝi.
Kiel vi povas vidi, ni havas detalan tabelon de propraĵoj kaj tuj havas instrukciojn pri kiel ĝuste konservi ĉi tiun paĝon. Kelkaj el la etikedoj estas aldonitaj de la dungitoj mem laŭ instrukcioj; la ŝablono enhavas nur la ĉefajn: kartetikedo dungito-karto, direkto-etikedo direkto-engaĝi kaj teametikedo team-qa.
Kiel rezulto, post kiam ĉiuj kreis karton por si, kompleta tabelo kun informoj pri dungitoj estas akirita. Ĉi tiu informo povas esti uzata ĉe malsamaj punktoj. Rimedaj administrantoj povas kolekti ĝeneralajn tabelojn por si mem, kaj teamgvidantoj povas krei teamajn tabelojn aldonante teametikedon al la elekto.
Vi povas vidi malsamajn resumojn per etikedoj, ekzemple qa-ĝisdatigo-plano Ĉiuj disvolvaj taskoj de QA estos montrataj. Samtempe ĉiu homo konservas gravan historion kaj sian propran disvolvan planon en sia dungita karto - kreas nestitan paĝon el la ŝablono pri evoluplanoj.
konkludo
Konservu ajnan dokumentadon tiel, ke ne estu honto en ĝi, kaj ĝi ne kaŭzas teruran doloron por uzantoj!
Mi vere esperas, ke la artikolo estos utila kaj ordo venos al la tuta dokumentado en la mondo.
fonto: www.habr.com