{"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\/sk\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","title":{"rendered":"Pou\u017e\u00edvate\u013esk\u00e1 dokument\u00e1cia: \u010do ju rob\u00ed zlou a ako to opravi\u0165","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"<p><img decoding=\"async\" alt=\"Pou\u017e\u00edvate\u013esk\u00e1 dokument\u00e1cia: \u010do ju rob\u00ed zlou a ako to opravi\u0165\" src=\"\/wp-content\/uploads\/2019\/03\/4381d63e81fbb299384255cb54dd34b5.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<br \/>\nDokument\u00e1cia k softv\u00e9ru je vlastne len s\u00fabor \u010dl\u00e1nkov. Ale aj tieto m\u00f4\u017eu by\u0165 frustruj\u00face. Najprv dlho h\u013ead\u00e1te spr\u00e1vny n\u00e1vod. Potom sa sna\u017e\u00edte pochopi\u0165 nejasn\u00fd text. Rob\u00edte to, \u010do je nap\u00edsan\u00e9, a probl\u00e9m sa nerie\u0161i. H\u013ead\u00e1te in\u00fd \u010dl\u00e1nok, nervujete sa... O hodinu sa na v\u0161etko vyka\u0161lete a od\u00eddete. Takto funguje zl\u00e1 dokument\u00e1cia. \u010co ju rob\u00ed takou a ako to opravi\u0165 \u2014 \u010d\u00edtajte \u010falej.<br \/>\n<noindex><a rel=\"nofollow\" name=\"habracut\"><\/a><\/noindex><\/p>\n<blockquote><p>V na\u0161ej starej dokument\u00e1cii bolo ve\u013ea nedostatkov. U\u017e takmer rok ju prepracov\u00e1vame, aby sa pop\u00edsan\u00fd scen\u00e1r net\u00fdkal na\u0161ich klientov. Pozrite sa, <noindex><a rel=\"nofollow\" href=\"https:\/\/doc.ispsystem.ru\/index.php\/\">ako to bolo<\/a><\/noindex> a <noindex><a rel=\"nofollow\" href=\"https:\/\/docs.ispsystem.ru\/\">ako to je teraz<\/a><\/noindex>.<\/p><\/blockquote>\n<p><\/p>\n<h2>Probl\u00e9m 1. Nejasn\u00e9, zle nap\u00edsan\u00e9 \u010dl\u00e1nky<\/h2>\n<p>\nAk sa v dokument\u00e1cii ned\u00e1 orientova\u0165, ak\u00fd m\u00e1 zmysel? Ale nikto nenap\u00ed\u0161e nejasn\u00e9 \u010dl\u00e1nky z\u00e1merne. Vznikaj\u00fa, ke\u010f autor neprem\u00fd\u0161\u013ea o publiku a cie\u013eoch, p\u00ed\u0161e nezmysly a nekontroluje text na chyby.<\/p>\n<ul>\n<li><b>Publikum<\/b>. Pred p\u00edsan\u00edm \u010dl\u00e1nku je potrebn\u00e9 zamyslie\u0165 sa nad \u00farov\u0148ou pr\u00edpravy \u010ditate\u013ea. Je logick\u00e9, \u017ee v \u010dl\u00e1nku pre za\u010diato\u010dn\u00edka by sa nemali vynech\u00e1va\u0165 z\u00e1kladn\u00e9 kroky a technick\u00e9 pojmy by nemali zosta\u0165 bez vysvetlenia, zatia\u013e \u010do v \u010dl\u00e1nku o zriedkavej funkcii, ktor\u00e1 je potrebn\u00e1 len pre profesion\u00e1lov, by sa nemalo rozobera\u0165, \u010do znamen\u00e1 slovo PHP.<\/li>\n<li><b>Cie\u013e<\/b>. E\u0161te jedna vec, o ktorej je dobr\u00e9 prem\u00fd\u0161\u013ea\u0165 vopred. Autor by mal ma\u0165 jasn\u00fd cie\u013e, ur\u010di\u0165 u\u017eito\u010dn\u00fa akciu \u010dl\u00e1nku a zisti\u0165, \u010do \u010ditate\u013e urob\u00ed po jeho pre\u010d\u00edtan\u00ed. Ak sa to neurob\u00ed, vznikne opis len tak pre opis. <\/li>\n<li><b>Zbyto\u010dn\u00e9 inform\u00e1cie a chyby<\/b>. Mno\u017estvo zbyto\u010dn\u00fdch inform\u00e1ci\u00ed a byrokratizmov, chyby a preklepy nar\u00fa\u0161aj\u00fa vn\u00edmanie. Aj ke\u010f \u010ditate\u013e nie je gram\u00e1rsky purista, nepozornos\u0165 v texte ho m\u00f4\u017ee odradi\u0165.<\/li>\n<\/ul>\n<p>\nZoh\u013eadnite rady vy\u0161\u0161ie a \u010dl\u00e1nky sa stan\u00fa zrozumite\u013enej\u0161\u00edmi \u2014 to je zaru\u010den\u00e9. Aby ste to e\u0161te zlep\u0161ili, vezmite na vedomie na\u0161ich <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/431456\/\"> 50 ot\u00e1zok pri pr\u00e1ci na technickej dokument\u00e1cii<\/a><\/noindex>.<\/p>\n<h2>Probl\u00e9m 2. \u010cl\u00e1nky neodpovedaj\u00fa na v\u0161etky ot\u00e1zky<\/h2>\n<p>\nJe zl\u00e9, ke\u010f dokument\u00e1cia nedok\u00e1\u017ee dr\u017ea\u0165 krok s v\u00fdvojom, neodpoved\u00e1 na re\u00e1lne ot\u00e1zky a chyby v nej sa neopravuj\u00fa roky. Toto s\u00fa probl\u00e9my nielen autora, ale sk\u00f4r organiz\u00e1cie procesov vn\u00fatri spolo\u010dnosti.<\/p>\n<h3>Dokument\u00e1cia nedok\u00e1\u017ee dr\u017ea\u0165 krok s v\u00fdvojom<\/h3>\n<p>\nFunkcia je u\u017e v release, marketing ju pl\u00e1nuje propagova\u0165, a ukazuje sa, \u017ee nov\u00e9ho \u010dl\u00e1nku alebo prekladu st\u00e1le niet v dokument\u00e1cii. Kv\u00f4li tejto situ\u00e1cii sme museli odlo\u017ei\u0165 vydanie. M\u00f4\u017eeme ko\u013ekokr\u00e1t po\u017eiada\u0165 v\u0161etk\u00fdch, aby v\u010das posielali \u00falohu technick\u00fdm spisovate\u013eom, ale to nebude fungova\u0165. Ak proces neautomatizujeme, situ\u00e1cia sa bude opakova\u0165.<\/p>\n<p>Zmenili sme YouTrack. \u00daloha na nap\u00edsanie \u010dl\u00e1nku o novej funkcii ide technick\u00e9mu spisovate\u013eovi v okamihu, ke\u010f sa za\u010dne s testovan\u00edm. Vtedy sa o nej dozvie aj marketing, aby sa mohol pripravi\u0165 na propag\u00e1ciu. Ozn\u00e1menia prich\u00e1dzaj\u00fa aj do firemn\u00e9ho messengeru Mattermost, tak\u017ee je nemo\u017en\u00e9 prehliadn\u00fa\u0165 novinky od v\u00fdvoj\u00e1rov.<\/p>\n<h3>Dokument\u00e1cia neodr\u00e1\u017ea po\u017eiadavky pou\u017e\u00edvate\u013eov<\/h3>\n<p>\nSme zvyknut\u00ed pracova\u0165 takto: funkcia vy\u0161la, my o nej hovor\u00edme. Op\u00ed\u0161eme, ako ju zapn\u00fa\u0165, vypn\u00fa\u0165, urobi\u0165 jemn\u00e9 nastavenia. Ale \u010do ak klient pou\u017e\u00edva n\u00e1\u0161 softv\u00e9r inak, ne\u017e sme predpokladali? Alebo ak sa vyskytn\u00fa chyby, na ktor\u00e9 sme nepomysleli?<\/p>\n<p>Aby bola dokument\u00e1cia \u010do naj\u00faplnej\u0161ia, odpor\u00fa\u010dame analyzova\u0165 po\u017eiadavky na podporu, ot\u00e1zky na tematick\u00fdch f\u00f3rach, dotazy vo vyh\u013ead\u00e1va\u010doch. Najpopul\u00e1rnej\u0161ie t\u00e9my posla\u0165 technick\u00fdm spisovate\u013eom, aby doplnili existuj\u00face \u010dl\u00e1nky alebo nap\u00edsali nov\u00e9.<\/p>\n<h3>Dokument\u00e1cia sa nezdokona\u013euje<\/h3>\n<p>\nJe \u0165a\u017ek\u00e9 urobi\u0165 to dokonale naraz, chyby sa aj tak vyskytn\u00fa. M\u00f4\u017eeme d\u00fafa\u0165 v sp\u00e4tn\u00fa v\u00e4zbu od klientov, ale \u0165a\u017eko poveda\u0165, \u010di sa im bude chcie\u0165 ozn\u00e1mi\u0165 ka\u017ed\u00fa chybu, nepresnos\u0165, nezrozumite\u013en\u00fd alebo nena\u0161iel \u010dl\u00e1nok. Okrem klientov dokument\u00e1ciu \u010d\u00edtaj\u00fa aj zamestnanci, a teda vidia tie ist\u00e9 chyby. To m\u00f4\u017eeme vyu\u017ei\u0165! Mus\u00edme len vytvori\u0165 podmienky, za ktor\u00fdch sa \u013eahko ozn\u00e1mi probl\u00e9m.<\/p>\n<p>M\u00e1me skupinu na internom port\u00e1li, kde zamestnanci zanech\u00e1vaj\u00fa pripomienky, n\u00e1vrhy a n\u00e1pady k dokument\u00e1cii. Podpora potrebovala \u010dl\u00e1nok, a ten nie je? Tester si v\u0161imol nepresnos\u0165? Partner si s\u0165a\u017eoval mana\u017e\u00e9rom rozvoja na chyby? V\u0161etko do tejto skupiny! Technick\u00ed spisovatelia nie\u010do hne\u010f opravia, nie\u010do prenes\u00fa do YouTrack, nie\u010do si vezm\u00fa na zamyslenie. Aby sa t\u00e9ma nezabudla, ob\u010das pripom\u00edname existenciu skupiny a d\u00f4le\u017eitos\u0165 sp\u00e4tnej v\u00e4zby.<\/p>\n<h2>Probl\u00e9m 3. Potrebn\u00fd \u010dl\u00e1nok sa mus\u00ed dlho h\u013eada\u0165<\/h2>\n<p>\n\u010cl\u00e1nok, ktor\u00fd nemo\u017eno n\u00e1js\u0165, nie je lep\u0161\u00ed ako \u010dl\u00e1nok, ktor\u00fd neexistuje. Mottom dobrej dokument\u00e1cie by mala by\u0165 fr\u00e1za \u201e\u013dahko h\u013eada\u0165, \u013eahko n\u00e1js\u0165\u201c. Ako to dosiahnu\u0165?<\/p>\n<p><b>Usporiada\u0165 \u0161trukt\u00faru a ur\u010di\u0165 princ\u00edp v\u00fdberu t\u00e9m<\/b>. \u0160trukt\u00fara by mala by\u0165 maxim\u00e1lne transparentn\u00e1, aby \u010ditate\u013e nemusel rozm\u00fd\u0161\u013ea\u0165 \u201eKde m\u00f4\u017eem n\u00e1js\u0165 tento \u010dl\u00e1nok?\u201c. Ak to zhrnieme, existuj\u00fa dva pr\u00edstupy: od rozhrania a od \u00faloh.<\/p>\n<ol>\n<li>Od rozhrania. Obsah duplikuje sekcie panelu. Tak to bolo v starej dokument\u00e1cii ISPsystem.<\/li>\n<li>Od \u00faloh. N\u00e1zvy \u010dl\u00e1nkov a sekci\u00ed odr\u00e1\u017eaj\u00fa \u00falohy pou\u017e\u00edvate\u013eov; v nadpisoch takmer v\u017edy s\u00fa sloves\u00e1 a odpovede na ot\u00e1zku \u201eako to urobi\u0165\u201c. Teraz prech\u00e1dzame do tak\u00e9ho form\u00e1tu.<\/li>\n<\/ol>\n<p>\nBez oh\u013eadu na pr\u00edstup, ktor\u00fd si vyberiete, uistite sa, \u017ee t\u00e9ma zodpoved\u00e1 po\u017eiadavk\u00e1m pou\u017e\u00edvate\u013eov a je spracovan\u00e1 tak, aby pou\u017e\u00edvate\u013e presne vyrie\u0161il svoj probl\u00e9m.<\/p>\n<p><b>Zavies\u0165 centralizovan\u00e9 vyh\u013ead\u00e1vanie<\/b>. V ide\u00e1lnom svete by malo vyh\u013ead\u00e1vanie fungova\u0165, aj ke\u010f sprav\u00edte preklep alebo sa pom\u00fdlite v jazyku. Na\u0161e vyh\u013ead\u00e1vanie v Confluence zatia\u013e t\u00fdmto nem\u00f4\u017ee pote\u0161i\u0165. Ak m\u00e1te ve\u013ea produktov a dokument\u00e1cia je spolo\u010dn\u00e1, prisp\u00f4sobte vyh\u013ead\u00e1vanie str\u00e1nke, na ktorej sa pou\u017e\u00edvate\u013e nach\u00e1dza. V na\u0161om pr\u00edpade vyh\u013ead\u00e1vanie na hlavnej str\u00e1nke funguje pre v\u0161etky produkty a ak sa u\u017e nach\u00e1dzate v konkr\u00e9tnej sekcii, tak iba pre \u010dl\u00e1nky v nej.<\/p>\n<p><b>Prida\u0165 obsah a \u201echlebov\u00e9 omrvinky\u201c<\/b>. Je dobr\u00e9, ke\u010f na ka\u017edej str\u00e1nke je menu a chlebov\u00e9 omrvinky \u2014 cesta pou\u017e\u00edvate\u013ea k aktu\u00e1lnej str\u00e1nke s mo\u017enos\u0165ou n\u00e1vratu na ak\u00fako\u013evek \u00farove\u0148. V starej dokument\u00e1cii ISPsystem bolo potrebn\u00e9 vyst\u00fapi\u0165 z \u010dl\u00e1nku, aby ste sa dostali k obsahu. Bolo to nepr\u00edjemn\u00e9, preto sme to v novej verzii opravili.<\/p>\n<p><b>Rozmiestni\u0165 odkazy v produkte<\/b>. Ak sa \u013eudia opakovane obracaj\u00fa na podporu s rovnakou ot\u00e1zkou, je rozumn\u00e9 prida\u0165 n\u00e1povedu s jej rie\u0161en\u00edm do rozhrania. Ak m\u00e1te d\u00e1ta alebo pochopenie, kedy pou\u017e\u00edvate\u013e naraz\u00ed na probl\u00e9m, m\u00f4\u017eete ho tie\u017e informova\u0165 e-mailom. T\u00fdmto prejav\u00edte starostlivos\u0165 a z\u00e1rove\u0148 zn\u00ed\u017eite z\u00e1\u0165a\u017e podpory.<\/p>\n<p><img decoding=\"async\" alt=\"Pou\u017e\u00edvate\u013esk\u00e1 dokument\u00e1cia: \u010do ju rob\u00ed zlou a ako to opravi\u0165\" src=\"\/wp-content\/uploads\/2019\/03\/ddf030647cf3271e0e34924ff5c8116f.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<i>Vpravo v okne s inform\u00e1ciami je odkaz na \u010dl\u00e1nok o nastaven\u00ed DNSSEC v sekcii spr\u00e1vy dom\u00e9n ISPmanager<\/i><\/p>\n<p><b>Nastavi\u0165 kr\u00ed\u017eov\u00e9 odkazy v r\u00e1mci dokument\u00e1cie<\/b>\u010cl\u00e1nky, kter\u00e9 si vz\u00e1jemn\u011b souvisej\u00ed, by m\u011bly b\u00fdt \u201eprolinkov\u00e1ny\u201c. Pokud \u010dl\u00e1nky tvo\u0159\u00ed posloupnost, nezapome\u0148te na konci ka\u017ed\u00e9ho textu p\u0159idat \u0161ipky vp\u0159ed a vzad.<\/p>\n<blockquote><p>S nejv\u011bt\u0161\u00ed pravd\u011bpodobnost\u00ed \u010dlov\u011bk nejprve p\u016fjde 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. Proto se postarejte o optimalizaci pro vyhled\u00e1va\u010de.<\/p><\/blockquote>\n<p><\/p>\n<h2>Probl\u00e9m 4. Zastaral\u00e1 typografie p\u0159ek\u00e1\u017e\u00ed vn\u00edm\u00e1n\u00ed<\/h2>\n<p>\nKrom\u011b \u0161patn\u00fdch text\u016f m\u016f\u017ee dokumentaci zkazit design. Lid\u00e9 jsou zvykl\u00ed \u010d\u00edst dob\u0159e zpracovan\u00e9 materi\u00e1ly. Blogy, soci\u00e1ln\u00ed s\u00edt\u011b, m\u00e9dia \u2014 ve\u0161ker\u00fd obsah je prezentov\u00e1n nejen kr\u00e1sn\u011b, ale i pohodln\u011b na \u010dten\u00ed a p\u0159\u00edjemn\u011b oku. Proto lze snadno pochopit bolest \u010dlov\u011bka, kter\u00fd vid\u00ed text jako na screenshotu 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=\"Pou\u017e\u00edvate\u013esk\u00e1 dokument\u00e1cia: \u010do ju rob\u00ed zlou a ako to opravi\u0165\" 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 p\u0159ek\u00e1\u017eej\u00ed vn\u00edm\u00e1n\u00ed (obr\u00e1zek je klikac\u00ed)<\/i><\/p>\n<p>Nen\u00ed dobr\u00e9 d\u011blat z dokumentace longread s hromadou efekt\u016f, ale z\u00e1kladn\u00ed pravidla je t\u0159eba vz\u00edt v \u00favahu. <\/p>\n<p><b>Typografie<\/b>. Ur\u010dete \u0161\u00ed\u0159ku hlavn\u00edho textu, p\u00edsmo, velikost, nadpisy a okraje. Zapojte design\u00e9ra, a abyste mohli pr\u00e1ci p\u0159ijmout nebo se s t\u00edm vypo\u0159\u00e1dat sami, p\u0159e\u010dt\u011bte si knihu Art\u011bma Gorbunova \u201eTypografie a sazba\u201c. V n\u00ed je p\u0159edstavena pouze jedna z perspektiv na typografii, ale je zcela dosta\u010duj\u00edc\u00ed.<\/p>\n<p><b>Zv\u00fdrazn\u011bn\u00ed<\/b>. Ur\u010dete, co vy\u017eaduje akcenty v textu. Obvykle to je cesta v rozhran\u00ed, tla\u010d\u00edtka, vlo\u017een\u00e9 k\u00f3dy, konfigura\u010dn\u00ed soubory, bloky \u201eV\u011bnujte pozornost\u201c. Ur\u010dete, jak\u00e1 budou zv\u00fdrazn\u011bn\u00ed t\u011bchto prvk\u016f a zaznamenejte to v regulaci. M\u011bjte na pam\u011bti, \u017ee \u010d\u00edm m\u00e9n\u011b zv\u00fdrazn\u011bn\u00ed, t\u00edm l\u00e9pe. Kdy\u017e jich je mnoho, text \u201e\u0161um\u00ed\u201c. Hluk vytv\u00e1\u0159\u00ed dokonce i uvozovky, pokud jsou pou\u017e\u00edv\u00e1ny p\u0159\u00edli\u0161 \u010dasto.<\/p>\n<p><b>Screenshoty<\/b>. Domluvte se s t\u00fdmem, v jak\u00fdch p\u0159\u00edpadech jsou pot\u0159eba 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, p\u0159ek\u00e1\u017e\u00ed vn\u00edm\u00e1n\u00ed a kaz\u00ed typografie. Ur\u010dete velikost a form\u00e1t zv\u00fdrazn\u011bn\u00ed a popisk\u016f na screenschotech, zaznamenejte v regulaci. Pamatujte, \u017ee ilustrace v\u017edy mus\u00ed odpov\u00eddat napsan\u00e9mu a b\u00fdt aktu\u00e1ln\u00ed. Op\u011bt, pokud se produkt pravideln\u011b aktualizuje, sledovat ka\u017ed\u00fd detail bude obt\u00ed\u017en\u00e9.<\/p>\n<p><b>D\u00e9lka textu<\/b>. Vyhnite sa pr\u00edli\u0161 dlh\u00fdm \u010dl\u00e1nkom. Rozde\u013ete ich na \u010dasti, a ak to nie je mo\u017en\u00e9, pridajte na za\u010diatok \u010dl\u00e1nku obsah s kotvov\u00fdmi odkazmi. Jednoduch\u00fd sp\u00f4sob, ako spravi\u0165 \u010dl\u00e1nok vizu\u00e1lne krat\u0161\u00edm, je skry\u0165 technick\u00e9 podrobnosti, ktor\u00e9 s\u00fa potrebn\u00e9 len \u00fazkemu publiku, pod spoilerom.<\/p>\n<p><b>Form\u00e1ty<\/b>. Kombinujte v \u010dl\u00e1nkoch nieko\u013eko form\u00e1tov: text, video a obr\u00e1zky. To zlep\u0161\u00ed vn\u00edmanie. <\/p>\n<blockquote><p>Nepok\u00fa\u0161ajte sa zakry\u0165 probl\u00e9my pekn\u00fdm dizajnom. \u00daprimne, aj my sme d\u00fafali, \u017ee \"obal\" zachr\u00e1ni zastaran\u00fa dokument\u00e1ciu \u2014 nevy\u0161lo to. V textoch bolo to\u013eko vizu\u00e1lneho hluku a zbyto\u010dn\u00fdch podrobnost\u00ed, \u017ee regul\u00e1cia a nov\u00fd dizajn boli bezmocn\u00e9.<\/p><\/blockquote>\n<p>\nMnoh\u00e9 z vy\u0161\u0161ie uveden\u00e9ho sa bude ur\u010dova\u0165 platformou, ktor\u00fa pou\u017e\u00edvate pre dokument\u00e1ciu. U n\u00e1s, napr\u00edklad, je to Confluence. S t\u00fdm sme sa tie\u017e museli pohra\u0165. Ak v\u00e1s zauj\u00edma, pre\u010d\u00edtajte si pr\u00edbeh n\u00e1\u0161ho webov\u00e9ho v\u00fdvoj\u00e1ra: <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/438236\/\">Confluence pre verejn\u00fa datab\u00e1zu znalost\u00ed: men\u00edme dizajn a nastavujeme rozdelenie pod\u013ea jazykov<\/a><\/noindex>.<\/p>\n<h2>Odkia\u013e za\u010da\u0165 zlep\u0161ovania a ako pre\u017ei\u0165<\/h2>\n<p>\nAk je va\u0161a dokument\u00e1cia tak\u00e1 rozsiahla ako u ISPsystem a neviete, za \u010do sa chyti\u0165, za\u010dnite s najv\u00e1\u017enej\u0161\u00edmi probl\u00e9mami. Klienti nech\u00e1pu dokument\u00e1ciu \u2014 venujte sa zlep\u0161eniu textov, vytvorte regul\u00e1cie, \u0161kolte autorov. Dokument\u00e1cia nie je aktu\u00e1lna \u2014 zaoberajte sa vn\u00fatorn\u00fdmi procesmi. Za\u010dnite s najpopul\u00e1rnej\u0161\u00edmi \u010dl\u00e1nkami o naj\u017eiadanej\u0161\u00edch produktoch: op\u00fdtajte sa podpory, pozrite sa na anal\u00fdzu str\u00e1nky a dopyty vo vyh\u013ead\u00e1va\u010doch. <\/p>\n<p>Hne\u010f povedzme \u2014 nebude to \u013eahk\u00e9. A r\u00fdchlo to tie\u017e asi nep\u00f4jde. Sk\u00f4r len ak pr\u00e1ve za\u010d\u00ednate a rob\u00edte to hne\u010f spr\u00e1vne. Jedno vieme ur\u010dite \u2014 \u010dasom to bude lep\u0161ie. 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.4 - 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\/sk\/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.4\" \/>\n\t\t<meta property=\"og:locale\" content=\"sk_SK\" \/>\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\/sk\/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\udd47Pou\u017e\u00edvate\u013esk\u00e1 dokument\u00e1cia: \u010do ju rob\u00ed zlou a ako to opravi\u0165 | ProHoster","description":"Dokument\u00e1cia k.","canonical_url":"https:\/\/prohoster.info\/sk\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":null,"og:locale":"sk_SK","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\/sk\/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\/sk\/wp-json\/wp\/v2\/posts\/42119","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/comments?post=42119"}],"version-history":[{"count":0,"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/posts\/42119\/revisions"}],"wp:attachment":[{"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/media?parent=42119"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/categories?post=42119"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/prohoster.info\/sk\/wp-json\/wp\/v2\/tags?post=42119"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}