Kumusta sa lahat!
Ang pangalan ko ay Masha, nagtatrabaho ako bilang isang inhinyero ng kalidad ng kasiguruhan sa grupo ng mga kumpanya ng Tinkoff. Ang gawain sa QA ay nagsasangkot ng maraming komunikasyon sa iba't ibang mga tao mula sa iba't ibang mga koponan, at isa rin akong tagapamahala at lektor ng mga programang pang-edukasyon, kaya ang aking mapa ng komunikasyon ay malawak hangga't maaari. At sa isang punto ay sumabog ako: Napagtanto ko na hindi ko na kaya, hindi ko na kaya, hindi ko mapupunan ang napakaraming impiyernong tonelada ng hindi nababasang mga talahanayan at dokumento.
Tiyak na naisip ng bawat isa sa inyo ngayon ang aking pinag-uusapan, at pinagpawisan sila: mga listahan ng mga apelyido na walang pagkakasunud-sunod ng alpabeto, mga talahanayan na may daan-daang mga hanay na may palpak na layout, mga talahanayan na may libu-libong linya kung saan kailangan mong burahin ang iyong daliri sa gulong ng mouse upang tingnan ang heading, tonelada ng mga pahina ng hindi mabilang na mga tagubilin, daan-daang mga titik na ipinadala sa isa't isa na may data na kailangang suriin at i-systematize at ilagay sa parehong hindi nababasa na mga talahanayan.
At kaya, nang medyo lumamig ako, nagpasya akong isulat ang artikulong ito. Pag-uusapan ko kung paano mo normal (kahit minsan ay maginhawa) na mapanatili ang iba't ibang dokumentasyong hindi produkto. Umaasa ako na ang artikulo ay makakalat sa network at ang antas ng impiyerno sa mga departamentong katabi ng pag-unlad ay bababa nang kaunti, at ang mga tao (kabilang ako) ay magiging mas masaya nang kaunti.
Tools
Ang dokumentasyon ng produkto ay madalas na itinatago kasama ng code, na isang magandang bagay. At ang dokumentasyong hindi produkto ay karaniwang iniimbak kahit saan. Kadalasan sinusubukan ng mga tao na magdala ng impormasyon mula sa iba't ibang lugar patungo sa Confluence, at hindi kami eksepsiyon. Kaya ang natitirang kwento ay tungkol sa kanya.
Sa pangkalahatan, ang Confluence ay isang advanced na wiki engine. Pinapayagan ka nitong magtrabaho kasama ang data sa iba't ibang uri ng display: text na may formatting, mga talahanayan, iba't ibang mga chart. Ito ay isang napaka-kawili-wili at makapangyarihang tool, ngunit kung hindi mo alam kung paano lutuin ito, pagkatapos ay makakakuha ka ng isa pang dump ng hindi nababasa na mga dokumento. Tuturuan kita kung paano magluto!
Macros
Halos lahat ng magic ng Confluence ay binuo sa paligid ng mga macro. Mayroong maraming mga macro, at maaari silang pagsamahin sa bawat isa. Ang mga ito ay binabayaran at libre, higit pa ay magkakaroon ng iba't ibang mga halimbawa ng mga macro na may mga link sa dokumentasyon para sa kanila.
Ang interface para sa pagtatrabaho sa mga macro ay kasing simple hangga't maaari. Upang magdagdag ng macro, kailangan mong mag-click sa plus at piliin ang nais na elemento mula sa listahan.
Kung ang macro ay sapat sa sarili, iyon ay, hindi ito nangangailangan ng pagpasok ng ibang bagay sa loob mismo, mukhang isang bloke.
Kung ang isang macro ay nangangailangan ng isang bagay sa loob nito upang gumana, ito ay mukhang isang kahon.
Kasabay nito, maaari kang maglagay ng maraming iba pa hangga't gusto mo sa loob ng isang frame, hangga't mayroong lohika sa iyong pyramid.
Ang bawat macro ay may preview: agad nitong ipinapakita kung napunan at na-configure mo nang tama ang macro.
Template
Bilang karagdagan sa mga macro, mayroong isang maginhawang tool para sa paunang pagpuno ng nilalaman - ito ay isang template.
Maaaring gamitin ang mga template kapag gumagawa ng anumang pahina: i-click lamang ang tatlong tuldok sa tabi ng button na "Lumikha" at piliin ang gustong template.
Pagkatapos ang lahat ng nilalaman na nasa template ay idadagdag sa nilikha na pahina.
Sinuman ay maaaring lumikha ng mga pahina mula sa mga template, ngunit ang mga may karapatang lumikha o mag-edit ng mga template mismo ang maaaring lumikha ng mga pahina. Maaari kang magdagdag ng mga karagdagang tagubilin sa template tungkol sa kung paano dapat panatilihin ang pahina.
Table Magic
Sa totoo lang, bilang isang techie, mahal na mahal ko ang mga mesa at kayang ibalot ang halos anumang impormasyon sa mga ito (bagaman hindi ito palaging epektibo). Ang mga talahanayan mismo ay malinaw, nakabalangkas, nasusukat, nakapagtataka!
Ngunit kahit na ang isang kahanga-hangang nilalang bilang isang mesa ay maaaring masira. At maaari itong matagumpay na magamit at mapahusay pa. Higit pa sa ibaba.
Pag-filter (bayad na plugin)
Anumang malaking hindi nababasang talahanayan ay maaaring gawing mas kaunti at mas nababasa gamit ang pag-filter. Upang gawin ito, maaari kang gumamit ng isang bayad na macro .
Sa loob ng macro na ito, kailangan mong itulak ang isang talahanayan (kahit na ang pinakapangit ay posible, ang pangunahing bagay ay itulak ito nang buo). Sa macro, maaari kang pumili ng mga column para sa drop-down na filter, text filter, numeric, at filter ng petsa.
Isipin na lang na ang lahat ng impormasyon sa mga kandidato para sa lahat ng mga bakante ay naitala sa isang tabular list. Naturally, unsorted - ang mga tao ay hindi pumupunta sa mga panayam sa alpabetikong pagkakasunud-sunod. At kailangan mong maunawaan kung nakapanayam ka ng isang partikular na aplikante dati. Kailangan mo lang ilagay ang impiyernong ito sa isang filter na macro, magdagdag ng filter ng teksto ayon sa apelyido - at voila, ang impormasyon ay nasa iyong screen.
Kapansin-pansin na ang pag-filter ng malalaking talahanayan ay maaaring makaapekto sa pagganap ng system at oras ng pag-load ng pahina, kaya ang paglalagay ng isang malaking talahanayan sa filter ay isang pansamantalang saklay, mas mahusay na bumuo ng isang proseso kung saan ang mga tao ay hindi kailangang lumikha ng malalaking hindi nababasa na mga talahanayan (isang halimbawa ng proseso ay nasa dulo ng artikulo).
Pag-uuri (bayad na plugin)
Gamit ang Magic Macro maaari mo ring itakda ang default na pag-uuri sa anumang column at bilangin ang mga row. O mag-click sa anumang column ng talahanayan na inilagay sa filter na macro, at ang pag-uuri ayon sa column na ito ay magaganap.
Halimbawa, mayroon kang parehong talahanayan sa mga aplikante at kailangan mong malaman kung gaano karaming mga panayam ang ginanap sa isang partikular na buwan - ayusin ayon sa petsa at magsaya.
Mga Pivot Table (bayad na plugin)
Ngayon ay lumipat tayo sa isang mas kawili-wiling kaso. Isipin na ang iyong talahanayan ay napakalaki at kailangan mong kalkulahin ang isang bagay dito. Siyempre, maaari mong kopyahin ito sa Excel, kalkulahin kung ano ang kailangan mo at i-upload ang data pabalik sa Confluence. Maaari ka bang mag-apply ng isang macro nang isang beses? at makakuha ng parehong resulta, na-update lamang.
Halimbawa: mayroon kang talahanayan na naglalaman ng data ng lahat ng empleyado - kung saan sila matatagpuan sa heograpiya at kung anong mga posisyon ang hawak nila. Upang kalkulahin kung gaano karaming tao ang nasa bawat lungsod, kailangan mong piliin sa macro na "Pivot Table" ang row kung saan pinagsasama-sama ang data (lokasyon) at ang uri ng operasyon (dagdag).
Naturally, maaari kang magpangkat ayon sa ilang pamantayan nang sabay-sabay, makikita mo ang lahat ng mga posibilidad .
Mga tsart (bayad na plugin)
Gaya nga ng sinabi ko, hindi lahat ay mahilig sa mga mesa gaya ko. Sa kasamaang palad, karamihan sa mga tagapamahala ay hindi gusto ang mga ito. Ngunit gustung-gusto ng lahat ang maliwanag na mga tsart ng kulay.
Tiyak na alam ito ng mga tagalikha ng Confluence (siguradong mayroon din silang mga boss na mahilig sa mga ulat at chart, nasaan sila kung wala ito). Samakatuwid, maaari mong gamitin ang magic macro . Sa macro na ito, kailangan mong ilagay ang pivot table mula sa nakaraang talata, at voila - ang iyong boring gray na data ay maganda ang visualized.
Naturally, ang macro na ito ay mayroon ding mga setting. Ang isang link sa dokumentasyon para sa anumang macro ay makikita sa edit mode ng macro na iyon.
Dali ng pagsasama-sama
Ang impormasyon mula sa mga nakaraang talata ay malamang na hindi isang paghahayag para sa iyo. Ngunit ngayon ay tiyak na alam mo na kung paano gumamit ng mga macro, at maaari akong magpatuloy sa mas kawili-wiling bahagi ng artikulo.
Mga label
Masama kapag ang mga tao ay nag-iimbak ng impormasyon sa isang hindi nakaayos na artikulo o isang malaking talahanayan. Ang mas masahol pa ay kapag ang mga bahagi ng impormasyong ito ay hindi lamang hindi nababasa, ngunit nakakalat din sa mga expanses ng Confluence. Sa kabutihang palad, posible na mangolekta ng mga nakakalat na impormasyon sa isang lugar. Para dito kailangan mong gamitin (mga tag na pamilyar sa lahat sa mga social network).
Anumang bilang ng mga tag ay maaaring idagdag sa anumang pahina. Ang pag-click sa isang tag ay magdadala sa iyo sa isang pahina ng pagsasama-sama na may mga link sa lahat ng nilalaman na may tag na iyon, pati na rin ang isang hanay ng mga nauugnay na tag. Ang mga nauugnay na tag ay ang mga madalas na lumalabas sa parehong page.
Mga katangian ng pahina
Maaari kang magdagdag ng isa pang kawili-wiling macro sa pahina para sa pag-istruktura ng impormasyon - . Sa loob nito, kailangan mong magsumite ng isang talahanayan ng dalawang hanay, ang una ay magiging susi, at ang pangalawa ay ang halaga ng ari-arian. Bukod dito, ang macro ay maaaring itago mula sa pahina upang hindi ito makagambala sa pagbabasa ng nilalaman, ngunit ang pahina ay mamarkahan pa rin ng mga kinakailangang key.
Bigyang-pansin ang ID - ito ay maginhawa upang itakda ito upang mag-hang ng iba't ibang mga grupo ng mga katangian sa iba't ibang mga pahina (o kahit na iba't ibang mga grupo ng mga katangian sa isang pahina).
Reports
Sa pamamagitan ng mga tag, maaari kang mangolekta ng mga ulat. Halimbawa, macro kinokolekta ang lahat ng mga pahina na may isang tiyak na hanay ng mga tag.
Ngunit ang isang mas kawili-wiling ulat ay isang macro . Kinokolekta din nito ang lahat ng mga pahina na may isang tiyak na hanay ng mga tag, ngunit hindi lamang inilista ang mga ito, ngunit nag-compile ng isang talahanayan (nahuhuli mo ba ang koneksyon sa simula ng artikulo?), Kung saan ang mga haligi ay ang mga susi ng mga katangian ng pahina.
Ito ay lumiliko ang isang talahanayan ng buod ng impormasyon mula sa iba't ibang mga mapagkukunan. Maganda na mayroon itong mga maginhawang tampok: adaptive layout, pag-uuri ayon sa anumang column. Gayundin, maaaring i-configure ang naturang talahanayan ng pag-uulat sa loob ng macro.
Kapag nagko-configure, maaari mong alisin ang ilang column sa ulat, itakda ang default na estado o ang bilang ng mga ipinapakitang tala. Maaari mo ring itakda ang page property ID upang makita lamang ang impormasyong kailangan mo.
Halimbawa, marami kang page ng empleyado, ang mga page na ito ay may set ng property tungkol sa isang tao: anong level siya, nasaan siya, noong sumali siya sa team, at iba pa. Ang mga katangiang ito ay minarkahan id = empleyado_inf. At mayroong pangalawang hanay ng mga pag-aari sa parehong pahina, na naglalaman ng impormasyon tungkol sa isang tao bilang bahagi ng isang koponan: kung anong papel ang ginagampanan ng tao, kung saang koponan siya naroroon, at iba pa. Ang mga katangiang ito ay minarkahan ID = team_inf. Pagkatapos, kapag nag-compile ng isang ulat, maaari ka lamang magpakita ng impormasyon para sa isang ID o dalawa nang sabay-sabay - alinman ang mas maginhawa.
Ang kagandahan ng diskarteng ito ay ang lahat ay maaaring mangolekta ng talahanayan ng impormasyon na kailangan nila, na hindi magdodoble ng anuman at maa-update kapag ang pangunahing pahina ay na-update. Halimbawa: walang pakialam ang isang team leader kapag nakakuha ng trabaho ang kanyang mga developer, ngunit mahalaga kung ano ang papel ng bawat isa sa kanila sa team. Ang pinuno ng pangkat ay mangolekta ng isang ulat sa koponan. At ang accountant ay walang pakialam kung sino ang gumaganap kung anong papel, ngunit ang mga posisyon ay mahalaga - siya ay mangolekta ng isang ulat sa mga posisyon. Sa kasong ito, hindi madodoble o ililipat ang pinagmulan ng impormasyon.
Pangwakas na proseso
Pagtuturo
Kaya, maganda ang pagkakabalangkas at epektibong pagsasama-sama natin ng impormasyon sa Confluence gamit ang mga macro bilang halimbawa. Ngunit sa isip, kailangan mong tiyakin na ang bagong impormasyon ay agad na naayos at nakapasok sa lahat ng mga mekanismo ng pagsasama-sama na ginagamit na.
Narito ang isang grupo ng mga macro at template ay darating upang iligtas. Upang mahikayat ang mga tao na lumikha ng mga bagong page sa tamang format, maaari mong gamitin ang macro na Lumikha mula sa Template. Nagdaragdag ito ng isang pindutan sa pahina, sa pamamagitan ng pag-click kung saan ang isang bagong pahina ay nilikha mula sa template na kailangan mo. Sa ganitong paraan, agad mong pinapagana ang mga tao sa format na kailangan mo.
Sa template kung saan mo pinapayagang lumikha ng isang pahina, kailangan mong magdagdag ng mga label, ang macro na "Mga Katangian ng Pahina" at isang talahanayan ng mga katangian na kailangan mo nang maaga. Inirerekomenda ko rin ang pagdaragdag ng mga tagubilin sa kung anong mga halaga ang pupunan sa pahina at mga halaga ng ari-arian.
Pagkatapos ang huling proseso ay magiging ganito:
- Gumagawa ka ng isang template para sa isang partikular na uri ng impormasyon.
- Sa template na ito, magdagdag ng mga label at property ng page sa isang macro.
- Sa anumang maginhawang lugar, lumikha ng isang pahina ng ugat na may isang pindutan, sa pamamagitan ng pag-click sa kung saan ang isang pahina ng bata ay nilikha mula sa template.
- Magsimula sa root page ng mga user na posibleng makabuo ng kinakailangang impormasyon (ayon sa gustong template, sa pamamagitan ng pag-click sa button).
- Kolektahin ang iyong sarili ng isang ulat sa mga katangian ng pahina sa pamamagitan ng mga tag na iyong tinukoy sa template.
- Magalak: mayroon kang lahat ng impormasyong kailangan mo sa isang maginhawang format.
Pitfalls
Bilang isang dekalidad na inhinyero, ligtas kong masasabi na walang perpekto sa mundo. Kahit na ang mga banal na talahanayan ay hindi perpekto. At may mga pitfalls sa proseso sa itaas.
- Kung magpasya kang baguhin ang mga pangalan o komposisyon ng mga pag-aari ng pahina, kakailanganin mong i-update ang lahat ng nagawa nang mga bagay upang ang kanilang data ay makuha nang tama sa ulat ng buod. Ito ay nakakalungkot, ngunit sa kabilang banda, pinipilit ka nitong mag-isip nang detalyado tungkol sa "arkitektura" ng iyong set ng impormasyon, na isang napaka-kagiliw-giliw na gawain.
- Kakailanganin mong magsulat ng isang disenteng dami ng mga tagubilin kung paano punan ang mga talahanayan ng impormasyon at gamitin ang mga tag. Ngunit, sa kabilang banda, maaari mo lamang itapon ang artikulong ito sa lahat ng tamang tao.
Isang halimbawa ng pag-iimbak ng dokumentasyong hindi produkto
Sa pamamagitan ng prosesong inilarawan sa itaas, maaari mong ayusin ang pag-iimbak ng halos anumang impormasyon. Ang kagandahan ng diskarte ay ito ay pangkalahatan: kapag nasanay na ang mga user, hihinto sila sa paggawa ng gulo. Ang isang malaking (ngunit hindi libre) plus ay ang kakayahang mangolekta ng iba't ibang mga istatistika sa mabilisang at gumuhit ng magagandang diagram dito.
Magbibigay ako ng isang halimbawa ng aming proseso ng pagpapanatili ng impormasyon tungkol sa koponan.
Para sa bawat tao sa koponan, nagpasya kaming lumikha ng isang card ng empleyado. Alinsunod dito, mayroon kaming isang template ayon sa kung saan nilikha ng bawat bagong tao ang card na ito para sa kanyang sarili at pinapanatili ang lahat ng kanyang personal na impormasyon dito.
Tulad ng nakikita mo, mayroon kaming isang detalyadong talahanayan ng mga pag-aari at may mga tagubilin kaagad kung paano panatilihin ang pahinang ito. Ang ilan sa mga tag ay inilagay ng mga empleyado mismo ayon sa mga tagubilin, sa template lamang ang mga pangunahing: ang card tag empleyado-card, tag ng direksyon direksyon-kasangkot at command tag team-qa.
Bilang isang resulta, pagkatapos ng lahat ay lumikha ng isang card para sa kanilang sarili, isang kumpletong talahanayan na may impormasyon sa mga empleyado ay nakuha. Maaaring gamitin ang impormasyong ito sa iba't ibang punto. Ang mga tagapamahala ng mapagkukunan ay maaaring mangolekta ng mga pangkalahatang talahanayan para sa kanilang sarili, at ang mga lead ng koponan ay maaaring mangolekta ng mga talahanayan ng command sa pamamagitan ng pagdaragdag ng tag ng koponan sa pagpili.
Sa pamamagitan ng mga tag, makakakita ka ng iba't ibang buod, halimbawa, ni qa-upgrade-plan lahat ng mga gawain para sa pagbuo ng QA ay ipapakita. Kasabay nito, ang bawat tao sa kanyang card ng empleyado ay nagpapanatili ng isang mahalagang kuwento at ang kanyang sariling plano sa pagpapaunlad - gumagawa siya ng isang nested na pahina mula sa template ng mga plano sa pagpapaunlad.
Konklusyon
Panatilihin ang anumang dokumentasyon sa paraang hindi mo ito ikinahihiya, at hindi labis na nasaktan ang mga user!
Talagang inaasahan ko na ang artikulo ay magiging kapaki-pakinabang at ang kaayusan ay darating sa lahat ng dokumentasyon ng mundo.
Pinagmulan: www.habr.com