{"id":42119,"date":"2019-03-18T00:00:00","date_gmt":"2019-03-17T21:00:00","guid":{"rendered":"https:\/\/prohoster.info\/blog\/blog_prohoster\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit"},"modified":"2020-02-18T13:44:55","modified_gmt":"2020-02-18T10:44:55","slug":"polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","status":"publish","type":"post","link":"https:\/\/prohoster.info\/cs\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","title":{"rendered":"U\u017eivatelsk\u00e1 dokumentace: co ji d\u011bl\u00e1 \u0161patnou a jak to opravit","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"<p><img decoding=\"async\" alt=\"U\u017eivatelsk\u00e1 dokumentace: co ji d\u011bl\u00e1 \u0161patnou a jak to opravit\" src=\"\/wp-content\/uploads\/2019\/03\/4381d63e81fbb299384255cb54dd34b5.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<br \/>\nDokumentace k softwaru je prost\u011b soubor \u010dl\u00e1nk\u016f. I ty v\u0161ak mohou b\u00fdt frustruj\u00edc\u00ed. Nejprve dlouho hled\u00e1te pot\u0159ebnou instrukci. Pak se sna\u017e\u00edte porozum\u011bt m\u00e1lo srozumiteln\u00e9mu textu. D\u011bl\u00e1te to, co je napsan\u00e9, ale probl\u00e9m se ne\u0159e\u0161\u00ed. Hled\u00e1te dal\u0161\u00ed \u010dl\u00e1nek, jste nerv\u00f3zn\u00ed\u2026 Po hodin\u011b se na v\u0161e vyka\u0161lete a odch\u00e1z\u00edte. Takto funguje \u0161patn\u00e1 dokumentace. Co ji d\u011bl\u00e1 takovou a jak to opravit \u2013 \u010dt\u011bte d\u00e1l.<br \/>\n<noindex><a rel=\"nofollow\" name=\"habracut\"><\/a><\/noindex><\/p>\n<blockquote><p>V na\u0161\u00ed star\u00e9 dokumentaci bylo mnoho nedostatk\u016f. U\u017e skoro rok ji p\u0159epracov\u00e1v\u00e1me, aby v\u00fd\u0161e zm\u00edn\u011bn\u00fd sc\u00e9n\u00e1\u0159 na\u0161e z\u00e1kazn\u00edky net\u00fdkal. Pod\u00edvejte se, <noindex><a rel=\"nofollow\" href=\"https:\/\/doc.ispsystem.ru\/index.php\/\">jak to bylo<\/a><\/noindex> a <noindex><a rel=\"nofollow\" href=\"https:\/\/docs.ispsystem.ru\/\">jak to vypad\u00e1 nyn\u00ed<\/a><\/noindex>.<\/p><\/blockquote>\n<p><\/p>\n<h2>Probl\u00e9m 1. Nejasn\u00e9, \u0161patn\u011b napsan\u00e9 \u010dl\u00e1nky<\/h2>\n<p>\nKdy\u017e se v dokumentaci ned\u00e1 naj\u00edt smysl, jak\u00fd to m\u00e1 v\u00fdznam? Ale nikdo p\u00ed\u0161e nejasn\u00e9 \u010dl\u00e1nky \u00famysln\u011b. Vznikaj\u00ed, kdy\u017e autor nep\u0159em\u00fd\u0161l\u00ed o publiku a c\u00edli, pl\u00fdtv\u00e1 slovy a nekontroluje text na chyby.<\/p>\n<ul>\n<li><b>Publikum<\/b>. P\u0159ed naps\u00e1n\u00edm \u010dl\u00e1nku je t\u0159eba p\u0159em\u00fd\u0161let o \u00farovni znalost\u00ed \u010dten\u00e1\u0159e. Je logick\u00e9, \u017ee v \u010dl\u00e1nku pro nov\u00e1\u010dka by se nem\u011bly vynech\u00e1vat z\u00e1kladn\u00ed kroky a technick\u00e9 term\u00edny by m\u011bly b\u00fdt vysv\u011btleny, zat\u00edmco v \u010dl\u00e1nku o raritn\u00ed funkci, kter\u00e1 je pot\u0159ebn\u00e1 pouze pro profesion\u00e1ly, by se skute\u010dnost PHP m\u011bla d\u016fkladn\u011b rozebrat.<\/li>\n<li><b>C\u00edl<\/b>. Dal\u0161\u00ed v\u011bc, na kterou je dobr\u00e9 myslet p\u0159edem. Autor by m\u011bl m\u00edt jasn\u00fd c\u00edl, ur\u010dit u\u017eite\u010dn\u00fd \u00fa\u010del \u010dl\u00e1nku a rozhodnout, co \u010dten\u00e1\u0159 ud\u011bl\u00e1 po jeho p\u0159e\u010dten\u00ed. Pokud se to neud\u011bl\u00e1, vznikne popis kv\u016fli popisu. <\/li>\n<li><b>P\u0159\u00edli\u0161n\u00e1 voda a chyby<\/b>. Mnoho zbyte\u010dn\u00fdch informac\u00ed a byrokratism\u016f, chyby a tiskov\u00e9 chyby zt\u011b\u017euj\u00ed pochopen\u00ed. I kdy\u017e \u010dten\u00e1\u0159 nen\u00ed gramatick\u00fdm pedantem, nedbalost v textu jej m\u016f\u017ee odradit.<\/li>\n<\/ul>\n<p>\nZva\u017ete v\u00fd\u0161e uveden\u00e9 rady a \u010dl\u00e1nky se stanou srozumiteln\u011bj\u0161\u00edmi \u2013 garantov\u00e1no. Abyste to je\u0161t\u011b v\u00edce zlep\u0161ili, vezm\u011bte si k srdci na\u0161e <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/431456\/\"> 50 ot\u00e1zek p\u0159i pr\u00e1ci na technick\u00e9 dokumentaci<\/a><\/noindex>.<\/p>\n<h2>Probl\u00e9m 2. \u010cl\u00e1nky neodpov\u00eddaj\u00ed na v\u0161echny ot\u00e1zky<\/h2>\n<p>\nJe \u0161patn\u00e9, kdy\u017e dokumentace nest\u00edh\u00e1 technick\u00fd v\u00fdvoj, neodpov\u00edd\u00e1 na skute\u010dn\u00e9 ot\u00e1zky a chyby v n\u00ed se neopravuj\u00ed po l\u00e9ta. To jsou probl\u00e9my v\u00edc ne\u017e autora, sp\u00ed\u0161e organizace proces\u016f ve firm\u011b.<\/p>\n<h3>Dokumentace nest\u00edh\u00e1 v\u00fdvoj<\/h3>\n<p>\nFunkce ji\u017e byla vydan\u00e1, marketing pl\u00e1nuje ji propagovat, ale ukazuje se, \u017ee v dokumentaci st\u00e1le nen\u00ed nov\u00fd \u010dl\u00e1nek nebo p\u0159eklad. Kv\u016fli tomu jsme museli dokonce odlo\u017eit vyd\u00e1n\u00ed. M\u016f\u017eeme vysv\u011btlovat v\u0161em, aby \u00fakoly v\u010das p\u0159ed\u00e1vali technick\u00fdm spisovatel\u016fm, ale to nebude fungovat. Pokud proces neautomatizujeme, situace se bude opakovat.<\/p>\n<p>Zavedli jsme zm\u011bny v YouTracku. \u00dakol na seps\u00e1n\u00ed \u010dl\u00e1nku o nov\u00e9 funkci p\u0159istane technick\u00e9mu spisovateli ve stejn\u00fd okam\u017eik, kdy za\u010dne testov\u00e1n\u00ed. Tehdy o n\u00ed tak\u00e9 marketing dozv\u00ed, aby se p\u0159ipravil na propagaci. Ozn\u00e1men\u00ed p\u0159ich\u00e1zej\u00ed tak\u00e9 do na\u0161eho firemn\u00edho messengeru Mattermost, tak\u017ee novinky od v\u00fdvoj\u00e1\u0159\u016f nen\u00ed mo\u017en\u00e9 p\u0159ehl\u00e9dnout.<\/p>\n<h3>Dokumentace neodr\u00e1\u017e\u00ed po\u017eadavky u\u017eivatel\u016f<\/h3>\n<p>\nJsme zvykl\u00ed pracovat takto: funkce vy\u0161la, my o n\u00ed informujeme. Popisujeme, jak ji povolit, zak\u00e1zat a prov\u00e1d\u011bt jemn\u00e1 nastaven\u00ed. Ale co kdy\u017e klient pou\u017e\u00edv\u00e1 n\u00e1\u0161 software zp\u016fsobem, kter\u00fd jsme ne\u010dekali? Nebo m\u00e1 chyby, o kter\u00fdch jsme nep\u0159em\u00fd\u0161leli?<\/p>\n<p>Aby byla dokumentace co nej\u00fapln\u011bj\u0161\u00ed, doporu\u010dujeme analyzovat dotazy podpory, ot\u00e1zky na specializovan\u00fdch f\u00f3rech, dotazy ve vyhled\u00e1va\u010d\u00edch. Nejobl\u00edben\u011bj\u0161\u00ed t\u00e9mata p\u0159edat technick\u00fdm spisovatel\u016fm, aby doplnili st\u00e1vaj\u00edc\u00ed \u010dl\u00e1nky nebo napsali nov\u00e9.<\/p>\n<h3>Dokumentace se nezdokonaluje<\/h3>\n<p>\nJe slo\u017eit\u00e9 ud\u011blat v\u0161e najednou perfektn\u00ed, chyby se stejn\u011b objev\u00ed. M\u016f\u017eeme doufat v zp\u011btnou vazbu od klient\u016f, ale st\u011b\u017e\u00ed se budou hl\u00e1sit ohledn\u011b ka\u017ed\u00e9ho p\u0159eklepu, nep\u0159esnosti nebo nejasn\u00e9ho \u010di nenalezen\u00e9ho \u010dl\u00e1nku. Krom\u011b klient\u016f dokumentaci \u010dtou tak\u00e9 zam\u011bstnanci, a proto vid\u00ed stejn\u00e9 chyby. To lze vyu\u017e\u00edt! Je pot\u0159eba vytvo\u0159it podm\u00ednky, v nich\u017e bude snadn\u00e9 hl\u00e1sit probl\u00e9m.<\/p>\n<p>M\u00e1me skupinu na intern\u00edm port\u00e1lu, kde zam\u011bstnanci zanech\u00e1vaj\u00ed koment\u00e1\u0159e, n\u00e1vrhy a n\u00e1pady k dokumentaci. Pot\u0159ebuje podpora \u010dl\u00e1nek, kter\u00fd neexistuje? Tester si v\u0161iml nep\u0159esnosti? Partner si st\u011b\u017eoval mana\u017eer\u016fm rozvoje na chyby? V\u0161e do t\u00e9to skupiny! Technick\u00ed spisovatel\u00e9 n\u011bco opravuj\u00ed ihned, n\u011bco p\u0159ev\u00e1d\u011bj\u00ed do YouTracku, n\u011bco berou na uv\u00e1\u017een\u00ed. Aby t\u00e9ma nezapadlo, \u010das od \u010dasu p\u0159ipom\u00edn\u00e1me existenci skupiny a d\u016fle\u017eitost zp\u011btn\u00e9 vazby.<\/p>\n<h2>Probl\u00e9m 3. Pot\u0159ebn\u00fd \u010dl\u00e1nek se mus\u00ed dlouho vyhled\u00e1vat<\/h2>\n<p>\n\u010cl\u00e1nek, kter\u00fd nelze naj\u00edt, nen\u00ed lep\u0161\u00ed ne\u017e \u010dl\u00e1nek, kter\u00fd neexistuje. Motto dobr\u00e9 dokumentace by m\u011blo b\u00fdt \u201eSnadno se hled\u00e1, snadno se nach\u00e1z\u00ed\u201c. Jak toho dos\u00e1hnout?<\/p>\n<p><b>Upravit strukturu a ur\u010dit princip v\u00fdb\u011bru t\u00e9mat<\/b>. Struktura by m\u011bla b\u00fdt co nejtransparentn\u011bj\u0161\u00ed, aby se \u010dten\u00e1\u0159 nezam\u00fd\u0161lel nad t\u00edm, \u201eKde mohu tuto str\u00e1nku naj\u00edt?\u201d. Pokud to shrneme, existuj\u00ed dva p\u0159\u00edstupy: od rozhran\u00ed a od \u00faloh.<\/p>\n<ol>\n<li>Od rozhran\u00ed. Obsah zrcadl\u00ed sekce panelu. Tak to bylo ve star\u00e9 dokumentaci ISPsystem.<\/li>\n<li>Od \u00faloh. N\u00e1zvy \u010dl\u00e1nk\u016f a sekc\u00ed odr\u00e1\u017eej\u00ed \u00fakoly u\u017eivatel\u016f; v nadpisech jsou t\u00e9m\u011b\u0159 v\u017edy slovesa a odpov\u011bdi na ot\u00e1zku \u201ejak to ud\u011blat\u201d. Nyn\u00ed p\u0159ech\u00e1z\u00edme na tento form\u00e1t.<\/li>\n<\/ol>\n<p>\nA\u0165 u\u017e zvol\u00edte jak\u00fdkoliv p\u0159\u00edstup, ujist\u011bte se, \u017ee t\u00e9ma odpov\u00edd\u00e1 dotaz\u016fm u\u017eivatel\u016f a je pokryto tak, aby u\u017eivatel jist\u011b vy\u0159e\u0161il sv\u016fj probl\u00e9m.<\/p>\n<p><b>Nastavit centralizovan\u00e9 vyhled\u00e1v\u00e1n\u00ed<\/b>. V ide\u00e1ln\u00edm sv\u011bt\u011b by vyhled\u00e1v\u00e1n\u00ed m\u011blo fungovat i p\u0159i p\u0159eklepech nebo chyb\u00e1ch v jazyce. Na\u0161e vyhled\u00e1v\u00e1n\u00ed v Confluence zat\u00edm tohle nedok\u00e1\u017ee. Pokud m\u00e1te mnoho produkt\u016f a dokumentace je obecn\u00e1, p\u0159izp\u016fsobte vyhled\u00e1v\u00e1n\u00ed podle str\u00e1nky, na kter\u00e9 se u\u017eivatel nach\u00e1z\u00ed. V na\u0161em p\u0159\u00edpad\u011b vyhled\u00e1v\u00e1n\u00ed na hlavn\u00ed str\u00e1nce funguje pro v\u0161echny produkty, a pokud se nach\u00e1z\u00edte v konkr\u00e9tn\u00ed sekci, pak pouze pro \u010dl\u00e1nky v n\u00ed.<\/p>\n<p><b>P\u0159idat obsah a \u201echl\u00e9b\u201c,<\/b>. Je dobr\u00e9, kdy\u017e na ka\u017ed\u00e9 str\u00e1nce existuje menu a chl\u00e9b \u2013 cesta u\u017eivatele k aktu\u00e1ln\u00ed str\u00e1nce s mo\u017enost\u00ed vr\u00e1tit se na jakoukoliv \u00farove\u0148. Ve star\u00e9 dokumentaci ISPsystem bylo t\u0159eba vyj\u00edt z \u010dl\u00e1nku, aby se dostali k obsahu. Bylo to nepohodln\u00e9, a proto jsme to v nov\u00e9m dokumentu opravili.<\/p>\n<p><b>Usm\u011brnit odkazy v produktu<\/b>. Pokud u\u017eivatel\u00e9 opakovan\u011b p\u0159ich\u00e1zej\u00ed na podporu se stejnou ot\u00e1zkou, je rozumn\u00e9 p\u0159idat n\u00e1pov\u011bdu s jej\u00edm \u0159e\u0161en\u00edm do rozhran\u00ed. Pokud m\u00e1te informace nebo ch\u00e1p\u00e1n\u00ed, v jak\u00fd okam\u017eik se u\u017eivatel setk\u00e1v\u00e1 s probl\u00e9mem, m\u016f\u017eete ho tak\u00e9 informovat prost\u0159ednictv\u00edm zas\u00edl\u00e1n\u00ed zpr\u00e1v. Tak prok\u00e1\u017eete p\u00e9\u010di a sn\u00ed\u017e\u00edte z\u00e1t\u011b\u017e na podporu.<\/p>\n<p><img decoding=\"async\" alt=\"U\u017eivatelsk\u00e1 dokumentace: co ji d\u011bl\u00e1 \u0161patnou a jak to opravit\" src=\"\/wp-content\/uploads\/2019\/03\/ddf030647cf3271e0e34924ff5c8116f.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<i>Vpravo v okn\u011b se zobrazuje odkaz na \u010dl\u00e1nek o nastaven\u00ed DNSSEC v sekci spr\u00e1vy dom\u00e9n ISPmanager<\/i><\/p>\n<p><b>Nastavit k\u0159\u00ed\u017eov\u00e9 odkazy v r\u00e1mci dokumentace<\/b>\u010cl\u00e1nky, kter\u00e9 jsou mezi sebou propojeny, by m\u011bly b\u00fdt \u201ezalinkov\u00e1ny\u201c. Pokud jsou \u010dl\u00e1nky v sekvenci, nezapome\u0148te na konci ka\u017ed\u00e9ho textu p\u0159idat \u0161ipky vp\u0159ed a vzad.<\/p>\n<blockquote><p>Pravd\u011bpodobn\u011b nejprve p\u016fjde \u010dlov\u011bk hledat odpov\u011b\u010f na svou ot\u00e1zku nikoli k v\u00e1m, ale do vyhled\u00e1va\u010de. Je nep\u0159\u00edjemn\u00e9, pokud tam z technick\u00fdch d\u016fvod\u016f nebudou odkazy na dokumentaci. Tak\u017ee se postarejte o vyhled\u00e1vac\u00ed optimalizaci.<\/p><\/blockquote>\n<p><\/p>\n<h2>Probl\u00e9m 4. Zastaral\u00e1 sazba br\u00e1n\u00ed vn\u00edm\u00e1n\u00ed<\/h2>\n<p>\nKrom\u011b \u0161patn\u00fdch text\u016f m\u016f\u017ee dokumentaci zkazit i design. Lid\u00e9 jsou zvykl\u00ed \u010d\u00edst dob\u0159e sazen\u00e9 materi\u00e1ly. Blogy, soci\u00e1ln\u00ed s\u00edt\u011b, m\u00e9dia \u2013 cel\u00fd obsah je pod\u00e1v\u00e1n nejen esteticky, ale i pohodln\u011b pro \u010dten\u00ed a p\u0159\u00edjemn\u011b na pohled. Proto je snadn\u00e9 pochopit bolest n\u011bkoho, kdo vid\u00ed text jako na sn\u00edmku n\u00ed\u017ee. <\/p>\n<p><noindex><a rel=\"nofollow\" href=\"https:\/\/hsto.org\/webt\/en\/8-\/3q\/en8-3qj_jpwfiie91efwo_igqtk.png\"><img decoding=\"async\" alt=\"U\u017eivatelsk\u00e1 dokumentace: co ji d\u011bl\u00e1 \u0161patnou a jak to opravit\" src=\"\/wp-content\/uploads\/2019\/03\/0a0762670770950d062e1cd4c0f33f1d.jpeg\" style=\"display:block;margin: 0 auto;\" \/><\/a><\/noindex><br \/>\n<i>V tomto \u010dl\u00e1nku je tolik screenshot\u016f a zv\u00fdrazn\u011bn\u00ed, \u017ee nepom\u00e1haj\u00ed, ale pouze br\u00e1n\u00ed vn\u00edm\u00e1n\u00ed (obr. je klikac\u00ed)<\/i><\/p>\n<p>Nen\u00ed dobr\u00e9 d\u011blat z dokumentace longread s mno\u017estv\u00edm efekt\u016f, ale z\u00e1kladn\u00ed pravidla je t\u0159eba zohlednit. <\/p>\n<p><b>Sazba<\/b>. Ur\u010dete \u0161\u00ed\u0159ku hlavn\u00edho textu, font, velikost, nadpisy a okraje. Zapojte design\u00e9ra, a abyste mohli p\u0159ijmout pr\u00e1ci nebo si poradili sami, p\u0159e\u010dt\u011bte si knihu \u0410\u0440\u0442\u0435\u043c\u0430 \u0413\u043e\u0440\u0431\u0443\u043d\u043e\u0432\u0430 \u201eTypografie a sazba\u201c. V n\u00ed je p\u0159edstaven pouze jeden pohled na sazbu, ale ten je zcela dosta\u010duj\u00edc\u00ed.<\/p>\n<p><b>Zv\u00fdrazn\u011bn\u00ed<\/b>. Ur\u010dte, co vy\u017eaduje akcent v textu. Obvykle to jsou cesty v rozhran\u00ed, tla\u010d\u00edtka, vlo\u017een\u00ed k\u00f3du, konfigura\u010dn\u00ed soubory, bloky \u201eV\u011bnujte pozornost\u201c. Ur\u010dete, jak\u00e1 budou zv\u00fdrazn\u011bn\u00ed t\u011bchto prvk\u016f a zafixujte to v p\u0159edpisech. M\u011bjte na pam\u011bti, \u017ee \u010d\u00edm m\u00e9n\u011b zv\u00fdrazn\u011bn\u00ed, t\u00edm l\u00e9pe. Kdy\u017e je jich mnoho, text \u201e\u0161um\u00ed\u201c. \u0160um vytv\u00e1\u0159ej\u00ed i uvozovky, pokud jsou pou\u017e\u00edv\u00e1ny p\u0159\u00edli\u0161 \u010dasto.<\/p>\n<p><b>Sn\u00edmek obrazovky<\/b>. Dohodn\u011bte se s t\u00fdmem, v jak\u00fdch p\u0159\u00edpadech jsou pot\u0159ebn\u00e9 screenshoty. Ilustrovat ka\u017ed\u00fd krok rozhodn\u011b nen\u00ed nutn\u00e9. Velk\u00e9 mno\u017estv\u00ed screenshot\u016f, v\u010detn\u011b jednotliv\u00fdch tla\u010d\u00edtek, br\u00e1n\u00ed vn\u00edm\u00e1n\u00ed a kaz\u00ed sazbu. Ur\u010dete velikost a form\u00e1t zv\u00fdrazn\u011bn\u00ed a popisk\u016f na screenech, zafixujte to v p\u0159edpisech. Pamatujte, \u017ee ilustrace by v\u017edy m\u011bly odpov\u00eddat napsan\u00e9mu a b\u00fdt aktu\u00e1ln\u00ed. Op\u011bt, pokud se produkt pravideln\u011b aktualizuje, sledovat ka\u017edou zm\u011bnu bude slo\u017eit\u00e9.<\/p>\n<p><b>D\u00e9lka textu<\/b>. Vyhn\u011bte se p\u0159\u00edli\u0161 dlouh\u00fdm \u010dl\u00e1nk\u016fm. Rozd\u011blte je na \u010d\u00e1sti, a pokud to nen\u00ed mo\u017en\u00e9, p\u0159idejte na za\u010d\u00e1tek \u010dl\u00e1nku obsah s kotvov\u00fdmi odkazy. Jednoduch\u00fd zp\u016fsob, jak \u010dl\u00e1nek vizu\u00e1ln\u011b zkr\u00e1tit, je skr\u00fdt technick\u00e9 detaily pot\u0159ebn\u00e9 \u00fazk\u00e9mu okruhu \u010dten\u00e1\u0159\u016f pod spoilerem.<\/p>\n<p><b>Form\u00e1ty<\/b>. Kombinujte v \u010dl\u00e1nc\u00edch n\u011bkolik form\u00e1t\u016f: text, video a obr\u00e1zky. To zlep\u0161\u00ed vn\u00edm\u00e1n\u00ed. <\/p>\n<blockquote><p>Nesna\u017ete se zakr\u00fdt probl\u00e9my hezk\u00fdm designem. Up\u0159\u00edmn\u011b, doufali jsme, \u017ee \"obal\" zachr\u00e1n\u00ed zastaralou dokumentaci - nepoda\u0159ilo se. V textech bylo tolik vizu\u00e1ln\u00edho \u0161umu a zbyte\u010dn\u00fdch podrobnost\u00ed, \u017ee sm\u011brnice a nov\u00e9 uspo\u0159\u00e1d\u00e1n\u00ed byly bezmocn\u00e9.<\/p><\/blockquote>\n<p>\nMnoh\u00e9 z v\u00fd\u0161e uveden\u00e9ho bude ur\u010deno platformou, kterou pou\u017e\u00edv\u00e1te pro dokumentaci. U n\u00e1s je to nap\u0159\u00edklad Confluence. S n\u00edm jsme tak\u00e9 museli trochu laborovat. Pokud v\u00e1s to zaj\u00edm\u00e1, p\u0159e\u010dt\u011bte si p\u0159\u00edb\u011bh na\u0161eho webov\u00e9ho v\u00fdvoj\u00e1\u0159e: <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/438236\/\">Confluence pro ve\u0159ejnou znalostn\u00ed z\u00e1kladnu: m\u011bn\u00edme design a nastavujeme rozd\u011blen\u00ed podle jazyk\u016f<\/a><\/noindex>.<\/p>\n<h2>Jak za\u010d\u00edt zlep\u0161en\u00ed a jak p\u0159e\u017e\u00edt<\/h2>\n<p>\nPokud je va\u0161e dokumentace stejn\u011b rozs\u00e1hl\u00e1 jako ta od ISPsystem a nev\u00edte, od \u010deho se za\u010d\u00edt, za\u010dn\u011bte s nejz\u00e1va\u017en\u011bj\u0161\u00edmi probl\u00e9my. Klienti dokumentaci nech\u00e1pou - zam\u011b\u0159te se na zlep\u0161en\u00ed text\u016f, vytvo\u0159te sm\u011brnice, \u0161kolte autory. Dokumentace nen\u00ed aktu\u00e1ln\u00ed - zam\u011b\u0159te se na vnit\u0159n\u00ed procesy. Za\u010dn\u011bte s nejpopul\u00e1rn\u011bj\u0161\u00edmi \u010dl\u00e1nky o nej\u017e\u00e1dan\u011bj\u0161\u00edch produktech: ptejte se podpory, pod\u00edvejte se na anal\u00fdzu webu a hled\u00e1n\u00ed v vyhled\u00e1va\u010d\u00edch. <\/p>\n<p>P\u0159ipravte se - nebude to snadn\u00e9. A ani rychl\u00e9 to pravd\u011bpodobn\u011b nebude. Snad, pokud pr\u00e1v\u011b za\u010d\u00edn\u00e1te a hned to d\u011bl\u00e1te spr\u00e1vn\u011b. Jedno v\u00edme jist\u011b - \u010dasem to bude lep\u0161\u00ed. Ale proces nikdy neskon\u010d\u00ed :-).<\/p>\n<p>Zdroj: <a content=\"nofollow\" rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/443648\/\">habr.com<\/a><\/p>","protected":false,"gt_translate_keys":[{"key":"rendered","format":"html"}]},"excerpt":{"rendered":"<p>\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a \u0441\u043e\u0444\u0442\u0443 \u2014 \u044d\u0442\u043e \u043f\u0440\u043e\u0441\u0442\u043e \u043d\u0430\u0431\u043e\u0440 \u0441\u0442\u0430\u0442\u0435\u0439. \u041d\u043e \u0434\u0430\u0436\u0435 \u043e\u043d\u0438 \u043c\u043e\u0433\u0443\u0442 \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0438\u0437 \u0441\u0435\u0431\u044f. \u0421\u043d\u0430\u0447\u0430\u043b\u0430 \u0434\u043e\u043b\u0433\u043e \u0438\u0449\u0435\u0448\u044c \u043d\u0443\u0436\u043d\u0443\u044e \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044e. \u041f\u043e\u0442\u043e\u043c \u0440\u0430\u0437\u0431\u0438\u0440\u0430\u0435\u0448\u044c\u0441\u044f \u0432 \u043c\u0430\u043b\u043e\u043f\u043e\u043d\u044f\u0442\u043d\u043e\u043c \u0442\u0435\u043a\u0441\u0442\u0435. \u0414\u0435\u043b\u0430\u0435\u0448\u044c \u043a\u0430\u043a \u043d\u0430\u043f\u0438\u0441\u0430\u043d\u043e, \u0430 \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0430 \u043d\u0435 \u0440\u0435\u0448\u0430\u0435\u0442\u0441\u044f. \u0418\u0449\u0435\u0448\u044c \u0434\u0440\u0443\u0433\u0443\u044e \u0441\u0442\u0430\u0442\u044c\u044e, \u043d\u0435\u0440\u0432\u043d\u0438\u0447\u0430\u0435\u0448\u044c\u2026 \u0427\u0435\u0440\u0435\u0437 \u0447\u0430\u0441 \u043f\u043b\u044e\u0451\u0448\u044c \u043d\u0430 \u0432\u0441\u0451 \u0438 \u0443\u0445\u043e\u0434\u0438\u0448\u044c. \u0422\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043f\u043b\u043e\u0445\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f. \u0427\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u0442\u0430\u043a\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c [&hellip;]<\/p>\n","protected":false,"gt_translate_keys":[{"key":"rendered","format":"html"}]},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[702],"tags":[],"class_list":["post-42119","post","type-post","status-publish","format-standard","hentry","category-news"],"aioseo_notices":[],"aioseo_head":"\n\t\t<!-- All in One SEO 5.0.3 - aioseo.com -->\n\t<meta name=\"description\" content=\"\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a.\" \/>\n\t<meta name=\"robots\" content=\"max-image-preview:large\" \/>\n\t<meta name=\"author\" content=\"Yuri Gagarin\"\/>\n\t<link rel=\"canonical\" href=\"https:\/\/prohoster.info\/cs\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit\" \/>\n\t\t<meta name=\"generator\" content=\"All in One SEO (AIOSEO) 5.0.3\" \/>\n\t\t<meta property=\"og:locale\" content=\"cs_CZ\" \/>\n\t\t<meta property=\"og:site_name\" content=\"ProHoster | \u041a\u0443\u043f\u0438\u0442\u044c \u043d\u0430\u0434\u0435\u0436\u043d\u044b\u0439 \u0445\u043e\u0441\u0442\u0438\u043d\u0433 \u0434\u043b\u044f \u0441\u0430\u0439\u0442\u043e\u0432 \u0441 \u0437\u0430\u0449\u0438\u0442\u043e\u0439 \u043e\u0442 DDoS, VPS VDS \u0441\u0435\u0440\u0432\u0435\u0440\u044b\" \/>\n\t\t<meta property=\"og:type\" content=\"article\" \/>\n\t\t<meta property=\"og:title\" content=\"\ud83e\udd47\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f: \u0447\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u043f\u043b\u043e\u0445\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c | ProHoster\" \/>\n\t\t<meta property=\"og:description\" content=\"\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a.\" \/>\n\t\t<meta property=\"og:url\" content=\"https:\/\/prohoster.info\/cs\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit\" \/>\n\t\t<meta property=\"og:image\" content=\"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg\" \/>\n\t\t<meta property=\"og:image:secure_url\" content=\"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg\" \/>\n\t\t<meta property=\"og:image:width\" content=\"350\" \/>\n\t\t<meta property=\"og:image:height\" content=\"350\" \/>\n\t\t<meta property=\"article:published_time\" content=\"2019-03-17T21:00:00+00:00\" \/>\n\t\t<meta property=\"article:modified_time\" content=\"2020-02-18T10:44:55+00:00\" \/>\n\t\t<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/prohoster\" \/>\n\t\t<meta property=\"article:author\" content=\"https:\/\/www.facebook.com\/prohoster\" \/>\n\t\t<!-- All in One SEO -->\n\n","aioseo_head_json":{"title":"\ud83e\udd47U\u017eivatelsk\u00e1 dokumentace: co ji d\u011bl\u00e1 \u0161patnou a jak to opravit | ProHoster","description":"Dokumentace k.","canonical_url":"https:\/\/prohoster.info\/cs\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":null,"og:locale":"cs_CZ","og:site_name":"ProHoster | \u041a\u0443\u043f\u0438\u0442\u044c \u043d\u0430\u0434\u0435\u0436\u043d\u044b\u0439 \u0445\u043e\u0441\u0442\u0438\u043d\u0433 \u0434\u043b\u044f \u0441\u0430\u0439\u0442\u043e\u0432 \u0441 \u0437\u0430\u0449\u0438\u0442\u043e\u0439 \u043e\u0442 DDoS, VPS VDS \u0441\u0435\u0440\u0432\u0435\u0440\u044b","og:type":"article","og:title":"\ud83e\udd47\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f: \u0447\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u043f\u043b\u043e\u0445\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c | ProHoster","og:description":"\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a.","og:url":"https:\/\/prohoster.info\/cs\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","og:image":"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg","og:image:secure_url":"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg","og:image:width":350,"og:image:height":350,"article:published_time":"2019-03-17T21:00:00+00:00","article:modified_time":"2020-02-18T10:44:55+00:00","article:publisher":"https:\/\/www.facebook.com\/prohoster","article:author":"https:\/\/www.facebook.com\/prohoster"},"aioseo_meta_data":{"post_id":"42119","title":null,"description":null,"keywords":null,"keyphrases":null,"primary_term":null,"canonical_url":null,"og_title":null,"og_description":null,"og_object_type":"default","og_image_type":"default","og_image_url":null,"og_image_width":null,"og_image_height":null,"og_image_custom_url":null,"og_image_custom_fields":null,"og_video":null,"og_custom_url":null,"og_article_section":null,"og_article_tags":null,"twitter_use_og":false,"twitter_card":"default","twitter_image_type":"default","twitter_image_url":null,"twitter_image_custom_url":null,"twitter_image_custom_fields":null,"twitter_title":null,"twitter_description":null,"schema":{"blockGraphs":[],"customGraphs":[],"default":{"data":{"Article":[],"Course":[],"Dataset":[],"FAQPage":[],"Movie":[],"Person":[],"Product":[],"ProductReview":[],"Car":[],"Recipe":[],"Service":[],"SoftwareApplication":[],"WebPage":[]},"graphName":"","isEnabled":true},"graphs":[]},"schema_type":null,"schema_type_options":null,"pillar_content":false,"robots_default":true,"robots_noindex":false,"robots_noarchive":false,"robots_nosnippet":false,"robots_nofollow":false,"robots_noimageindex":false,"robots_noodp":false,"robots_notranslate":false,"robots_max_snippet":null,"robots_max_videopreview":null,"robots_max_imagepreview":"large","priority":null,"frequency":null,"local_seo":null,"seo_analyzer_scan_date":"2026-01-22 07:20:19","breadcrumb_settings":null,"limit_modified_date":false,"reviewed_by":null,"ai":null,"created":"2021-03-01 00:05:22","updated":"2026-01-22 07:20:19","focus_keyword":null,"additional_keywords":null,"truseo_locale":null},"gt_translate_keys":[{"key":"link","format":"url"}],"_links":{"self":[{"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/posts\/42119","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/comments?post=42119"}],"version-history":[{"count":0,"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/posts\/42119\/revisions"}],"wp:attachment":[{"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/media?parent=42119"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/categories?post=42119"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/prohoster.info\/cs\/wp-json\/wp\/v2\/tags?post=42119"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}