{"id":35419,"date":"2019-10-31T22:04:14","date_gmt":"2019-10-31T19:04:14","guid":{"rendered":"https:\/\/prohoster.info\/blog\/ispolzujte-git-pri-dokumentirovanii\/"},"modified":"2019-10-31T22:04:14","modified_gmt":"2019-10-31T19:04:14","slug":"ispolzujte-git-pri-dokumentirovanii","status":"publish","type":"post","link":"https:\/\/prohoster.info\/cs\/blog\/administrirovanie\/ispolzujte-git-pri-dokumentirovanii","title":{"rendered":"Pou\u017eijte GIT p\u0159i dokumentov\u00e1n\u00ed","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

N\u011bkdy m\u016f\u017ee b\u00fdt kritick\u00fd nejen samotn\u00fd dokument, ale i proces pr\u00e1ce na n\u011bm. Nap\u0159\u00edklad u projekt\u016f je velk\u00e1 \u010d\u00e1st pr\u00e1ce spojena pr\u00e1v\u011b s p\u0159\u00edpravou dokumentace a nespr\u00e1vn\u00fd proces m\u016f\u017ee v\u00e9st k chyb\u00e1m a dokonce ke ztr\u00e1t\u011b informac\u00ed, a tud\u00ed\u017e i k ztr\u00e1t\u011b \u010dasu a zisku. I kdy\u017e toto t\u00e9ma nen\u00ed centr\u00e1ln\u00ed v va\u0161\u00ed pr\u00e1ci a je na okraji, spr\u00e1vn\u00fd proces st\u00e1le m\u016f\u017ee zlep\u0161it kvalitu dokumentu a u\u0161et\u0159it v\u00e1m \u010das.<\/p>\n

P\u0159\u00edstup uveden\u00fd zde, s p\u0159\u00edkladem konkr\u00e9tn\u00ed realizace<\/a><\/noindex>, m\u00e1 n\u00edzk\u00fd vstupn\u00ed pr\u00e1h. Technicky m\u016f\u017eete u\u017e z\u00edtra za\u010d\u00edt pracovat jinak.
\n<\/a><\/noindex><\/p>\n

Formulace \u00fakolu<\/h3>\n

\nMus\u00edte vytvo\u0159it ur\u010dit\u00fd dokument nebo sadu dokument\u016f. M\u016f\u017ee to b\u00fdt projektov\u00e1 dokumentace nebo protokolov\u00e1n\u00ed va\u0161\u00ed s\u00edt\u011b, nebo n\u011bco jednodu\u0161\u0161\u00edho, nap\u0159\u00edklad pot\u0159ebujete popsat procesy ve spole\u010dnosti nebo ve va\u0161em odd\u011blen\u00ed. Obecn\u011b \u0159e\u010deno, jde o jak\u00fdkoli dokument nebo sadu dokument\u016f s textem, obr\u00e1zky, tabulkami\u2026 Zt\u00ed\u017e\u00edme \u00fakol t\u00edm, \u017ee <\/p>\n

    \n
  1. tato pr\u00e1ce p\u0159edpokl\u00e1d\u00e1 spole\u010dn\u00e9 \u00fasil\u00ed skupiny nebo n\u011bkolika skupin zam\u011bstnanc\u016f<\/li>\n
  2. na v\u00fdstupu chcete m\u00edt dokument v ur\u010dit\u00e9m form\u00e1tu, s atributy firemn\u00edho stylu, vytvo\u0159en\u00fd podle ur\u010dit\u00e9 \u0161ablony. Pro ur\u010dit\u00e9 ur\u010den\u00ed budeme pova\u017eovat, \u017ee to je MS Word (.docx)<\/li>\n<\/ol>\n

    \nP\u0159ed 10 lety by byl p\u0159\u00edstup jednozna\u010dn\u00fd: vytvo\u0159ili bychom dokumenty MS Word a n\u011bjak\u00fdm zp\u016fsobem zorganizovali pr\u00e1ci na zm\u011bn\u00e1ch. <\/p>\n

    A tento p\u0159\u00edstup z\u016fst\u00e1v\u00e1 platn\u00fd. Pou\u017e\u00edvaj\u00ed ho i velc\u00ed integr\u00e1to\u0159i p\u0159i vytv\u00e1\u0159en\u00ed projektov\u00e9 dokumentace. Ale intuitivn\u011b je z\u0159ejm\u00e9, \u017ee pokud na dokumentu skute\u010dn\u011b intenzivn\u011b pracujete, s mnoha \u00fapravami a diskusemi po del\u0161\u00ed dobu, nen\u00ed tento p\u0159\u00edstup p\u0159\u00edli\u0161 pohodln\u00fd.<\/p>\n

    P\u0159\u00edklad<\/b><\/p>\n

    Tuto problematiku jsem intenzivn\u011b poc\u00edtil, kdy\u017e jsem pracoval v jednom velk\u00e9m integr\u00e1torovi. Proces zm\u011bny projektov\u00e9 dokumentace byl n\u00e1sleduj\u00edc\u00ed:<\/p>\n

      \n
    1. in\u017een\u00fdr st\u00e1hne posledn\u00ed verzi dokumentu MS Word (.docx)<\/li>\n
    2. zm\u011bn\u00ed n\u00e1zev<\/li>\n
    3. prov\u00e1d\u00ed \u00fapravy v re\u017eimu sledov\u00e1n\u00ed<\/li>\n
    4. pos\u00edl\u00e1 dokument s \u00fapravami architektovi<\/li>\n
    5. tak\u00e9 pos\u00edl\u00e1 seznam v\u0161ech oprav s koment\u00e1\u0159i<\/li>\n
    6. architekt analyzuje zm\u011bny<\/li>\n
    7. pokud je v\u0161e v po\u0159\u00e1dku, zkop\u00edruje tyto zm\u011bny do souboru s posledn\u00ed verz\u00ed, zm\u011bn\u00ed verzi a nahr\u00e1v\u00e1 na sd\u00edlen\u00fd zdroj<\/li>\n
    8. pokud jsou p\u0159ipom\u00ednky, zah\u00e1j\u00ed se diskuse (e-mailem nebo na sch\u016fzk\u00e1ch)<\/li>\n
    9. dos\u00e1hne se konsenzu<\/li>\n
    10. d\u00e1le body 3 \u2013 9<\/li>\n<\/ol>\n

      \nKdy\u017e pr\u00e1ce nebyla intenzivn\u00ed, fungovalo to n\u011bjak, ale p\u0159ece jen to fungovalo. Ale v ur\u010dit\u00e9m okam\u017eiku se tento proces stal \u00fazk\u00fdm m\u00edstem cel\u00e9ho projektu a vedl k probl\u00e9m\u016fm. Probl\u00e9m je, \u017ee v\u0161echno jde \u0161patn\u011b, jakmile se zm\u011bny prov\u00e1d\u011bj\u00ed \u010dasto a sou\u010dasn\u011b n\u011bkolika t\u00fdmy.<\/p>\n

      Kdy\u017e jsme p\u0159e\u0161li do f\u00e1ze p\u0159edb\u011b\u017en\u00e9ho testov\u00e1n\u00ed, za\u010daly se objevovat r\u016fzn\u00e9 probl\u00e9my a a\u010dkoliv \u0161lo o drobnosti, bylo \u010dasto pot\u0159eba m\u011bnit dokumentaci \u2014 \u010dty\u0159i r\u016fzn\u00e9 t\u00fdmy, denn\u011b, prakticky sou\u010dasn\u011b, s diskuzemi. V\u0161echny tyto zm\u011bny proch\u00e1zely jedn\u00edm in\u017een\u00fdrem \u2014 architektem. Soubor s n\u00e1vrhem projektu byl obrovsk\u00fd, a n\u00e1sledn\u011b byl architekt zat\u00ed\u017een rutinn\u00ed prac\u00ed spojenou s velk\u00fdm mno\u017estv\u00edm kop\u00edrov\u00e1n\u00ed, editov\u00e1n\u00ed, d\u011blal mnoho chyb, bylo pot\u0159eba v\u0161e dvakr\u00e1t zkontrolovat, znovu pos\u00edlat, a celkov\u011b to bylo bl\u00edzko chaosu. <\/p>\n

      V tomto p\u0159\u00edpad\u011b tento p\u0159\u00edstup, p\u0159\u00edstup pr\u00e1ce s dokumentem MS Word, fungoval s velk\u00fdm skluzem a vytv\u00e1\u0159el probl\u00e9my.<\/p><\/blockquote>\n

      <\/p>\n

      Git, Markdown<\/h3>\n

      \nKdy\u017e jsem se setkal s probl\u00e9mem popsan\u00fdm ve v\u00fd\u0161e uveden\u00e9m p\u0159\u00edkladu, za\u010dal jsem tento probl\u00e9m zkoumat.
      \nVid\u011bl jsem, \u017ee st\u00e1le v\u00edce se st\u00e1v\u00e1 popul\u00e1rn\u00ed pou\u017e\u00edv\u00e1n\u00ed       Markdown<\/a><\/noindex> ve spojen\u00ed s Git<\/a><\/noindex> p\u0159i vytv\u00e1\u0159en\u00ed dokument\u016f.<\/p>\n

      Git je n\u00e1stroj pro v\u00fdvoj. Ale pro\u010d ho nepou\u017e\u00edt pro proces dokumentace? V tomto p\u0159\u00edpad\u011b je ot\u00e1zka v\u00edcestup\u0148ov\u00e9 pr\u00e1ce vy\u0159e\u0161ena. Abychom v\u0161ak pln\u011b vyu\u017eili mo\u017enosti Gitu, pot\u0159ebujeme textov\u00fd form\u00e1t dokumentu, pot\u0159ebujeme naj\u00edt jin\u00fd n\u00e1stroj, ne MS Word, a pro tyto \u00fa\u010dely je Markdown ide\u00e1ln\u00ed. <\/p>\n

      Markdown je jednoduch\u00fd jazyk pro textov\u00e9 zna\u010den\u00ed. Je ur\u010den k vytv\u00e1\u0159en\u00ed p\u011bkn\u011b form\u00e1tovan\u00fdch text\u016f v b\u011b\u017en\u00fdch TXT souborech. Pokud budeme vytv\u00e1\u0159et na\u0161e dokumenty v Markdownu, pak vazba Markdown \u2014 Git vypad\u00e1 p\u0159irozen\u011b.<\/p>\n

      V\u0161e by bylo v po\u0159\u00e1dku a mohli bychom tuto \u010d\u00e1st uzav\u0159\u00edt, kdyby nebylo na\u0161eho druh\u00e9ho po\u017eadavku: \u201ena v\u00fdstupu pot\u0159ebujeme dokument v ur\u010dit\u00e9m form\u00e1tu, se zn\u00e1mkami firemn\u00edho stylu, vytvo\u0159en\u00fd podle ur\u010dit\u00e9 \u0161ablony\u201c (a dohodli jsme se na za\u010d\u00e1tku, \u017ee pro jistotu to bude MS Word). To znamen\u00e1, \u017ee pokud jsme se rozhodli pou\u017e\u00edt Markdown, mus\u00edme n\u011bjak p\u0159ev\u00e9st tento soubor na .docx po\u017eadovan\u00e9ho vzhledu.<\/p>\n

      Existuj\u00ed programy na p\u0159evod mezi r\u016fzn\u00fdmi form\u00e1ty, nap\u0159\u00edklad, Pandoc<\/a><\/noindex>.
      \nM\u016f\u017eete p\u0159ev\u00e9st soubor Markdown do form\u00e1tu .docx pomoc\u00ed tohoto programu.
      \nAle i tak je t\u0159eba ch\u00e1pat, \u017ee za prv\u00e9, ne v\u0161echno, co je v Markdown, bude p\u0159evedeno do MS Word a za druh\u00e9, MS Word je cel\u00e1 zem\u011b ve srovn\u00e1n\u00ed s kompaktn\u00edm, ale p\u0159ece jen m\u011bste\u010dkem, kter\u00fdm Markdown je. Existuje obrovsk\u00e9 mno\u017estv\u00ed funkc\u00ed, kter\u00e9 MS Word nab\u00edz\u00ed a kter\u00e9 v \u017e\u00e1dn\u00e9m p\u0159\u00edpad\u011b nejsou v Markdown. Nelze jednodu\u0161e vz\u00edt a s ur\u010dit\u00fdmi kl\u00ed\u010di p\u0159ev\u00e9st v\u00e1\u0161 Markdown form\u00e1t do po\u017eadovan\u00e9ho vzhledu MS Word pomoc\u00ed Pandoc. Obvykle tedy, po p\u0159evodu, je nutn\u00e9 \u201edopracovat\u201c z\u00edskan\u00fd dokument .docx ru\u010dn\u011b, co\u017e op\u011bt m\u016f\u017ee b\u00fdt \u010dasov\u011b n\u00e1ro\u010dn\u00e9 a m\u016f\u017ee v\u00e9st k chyb\u00e1m.<\/p>\n

      Kdybychom mohli napsat skript, kter\u00fd by automaticky \u201edopracov\u00e1val\u201c to, s \u010d\u00edm si Pandoc neporadil \u2013 to by bylo ide\u00e1ln\u00ed \u0159e\u0161en\u00ed.<\/p>\n

      Vzhledem k nesrovnatelnosti funkc\u00ed MS Word a Markdown obecn\u011b je podle m\u00e9ho n\u00e1zoru vy\u0159e\u0161en\u00ed tohoto \u00fakolu nemo\u017en\u00e9, ale lze to aplikovat na konkr\u00e9tn\u00ed situace, konkr\u00e9tn\u00ed po\u017eadavky? Moje zku\u0161enost ukazuje, \u017ee ano, je to mo\u017en\u00e9 a pravd\u011bpodobn\u011b to mo\u017en\u00e9 je pro mnoh\u00e9, nebo mo\u017en\u00e1 dokonce pro v\u011bt\u0161inu situac\u00ed. <\/p>\n

      \u0158e\u0161en\u00ed specifick\u00e9ho \u00fakolu<\/h3>\n

      \nTak\u017ee v m\u00e9m p\u0159\u00edpad\u011b, po p\u0159evodu souboru pomoc\u00ed Pandoc, jsem musel ru\u010dn\u011b prov\u00e9st dodate\u010dn\u00e9 zpracov\u00e1n\u00ed soubor\u016f, a to konkr\u00e9tn\u011b<\/p>\n