{"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\/et\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","title":{"rendered":"Kasutajate dokumentatsioon: mis teeb selle kehvaks ja kuidas seda parandada","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"<p><img decoding=\"async\" alt=\"Kasutajate dokumentatsioon: mis teeb selle kehvaks ja kuidas seda parandada\" src=\"\/wp-content\/uploads\/2019\/03\/4381d63e81fbb299384255cb54dd34b5.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<br \/>\nTarkvara dokumentatsioon on lihtsalt artiklite kogum. Kuid isegi need v\u00f5ivad olla t\u00fc\u00fctu. Alguses otsid kaua vajalikke juhiseid. Siis p\u00fc\u00fcad aru saada arusaamatust tekstist. Tegutsed nagu on kirjutatud, aga probleem ei lahene. Otsid teist artiklit, \u00e4rritute... Tunni aja p\u00e4rast loobud k\u00f5ikest ja lahkud. Nii t\u00f6\u00f6tab halb dokumentatsioon. Miks see nii on ja kuidas seda parandada \u2014 loe edasi.<br \/>\n<noindex><a rel=\"nofollow\" name=\"habracut\"><\/a><\/noindex><\/p>\n<blockquote><p>Meie vanas dokumentatsioonis oli palju puuduseid. Juba peaaegu aasta oleme seda t\u00f6\u00f6tanud, et eespool kirjeldatud stsenaarium ei m\u00f5jutaks meie kliente. Vaata, <noindex><a rel=\"nofollow\" href=\"https:\/\/doc.ispsystem.ru\/index.php\/\">kuidas see oli<\/a><\/noindex> ja <noindex><a rel=\"nofollow\" href=\"https:\/\/docs.ispsystem.ru\/\">kuidas see on n\u00fc\u00fcd<\/a><\/noindex>.<\/p><\/blockquote>\n<p><\/p>\n<h2>Probleem 1. Arusaamatud, halvasti kirjutatud artiklid<\/h2>\n<p>\nKui dokumentatsioonis ei saa aru, milline on selle m\u00f5te? Kuid keegi ei kirjuta arusaamatuid artikleid spetsiaalselt. Need tekivad, kui autor ei m\u00f5tle publikule ja eesm\u00e4rgile, kirjutab liigseid detaile ja ei kontrolli teksti vigade osas.<\/p>\n<ul>\n<li><b>Publik<\/b>. Enne artikli kirjutamist tuleks m\u00f5elda lugeja ettevalmistustasemele. On loogiline, et algajatele suunatud artiklis ei tasu j\u00e4tta vahele p\u00f5hietappe ega kasutada tehnilisi termineid seletamata, samas kui haruldase funktsiooni, mida vajavad vaid professionaalid, puhul tuleks s\u00f5na PHP t\u00e4hendust p\u00f5hjalikult selgitada.<\/li>\n<li><b>Eesm\u00e4rk<\/b>. Veel \u00fcks asi, millele on parem eelnevalt m\u00f5elda. Autor peaks seadma selge eesm\u00e4rgi, m\u00e4\u00e4ratlema artikli kasuliku tegevuse ja otsustama, mida lugeja p\u00e4rast selle lugemist teeb. Kui seda ei tehta, j\u00e4\u00e4b jutt ainult jutu p\u00e4rast. <\/li>\n<li><b>Vesi ja vead<\/b>. Liigne informatsioon ja b\u00fcrokraatia, vead ja tr\u00fckivead takistavad arusaamist. Ieven kui lugeja ei ole grammatikanaats, v\u00f5ib tekstis hooletus teda eemale t\u00f5ukata.<\/li>\n<\/ul>\n<p>\nKasutage \u00fclaltoodud n\u00e4pun\u00e4iteid ja artiklid saavad selgemaks - garanteeritud. Selle veelgi paremaks muutmiseks, v\u00f5tke kasutusele meie <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/431456\/\"> 50 k\u00fcsimust tehnilise dokumentatsiooni kirjutamisel<\/a><\/noindex>.<\/p>\n<h2>Probleem 2. Artiklid ei vasta k\u00f5igile k\u00fcsimustele<\/h2>\n<p>\nHalb on, kui dokumentatsioon ei j\u00e4rgi arendust, ei vasta tegelikele k\u00fcsimustele ja vead j\u00e4\u00e4vad seal mitmeks aastaks parandamata. Need on probleemid, mis ei ole niiv\u00f5rd autori, vaid ettev\u00f5tte siseste protsesside k\u00fcsimus.<\/p>\n<h3>Dokumentatsioon ei j\u00e4rgi arendust<\/h3>\n<p>\nFunktsioon on juba v\u00e4lja antud, turundus kavatseb selle kohta teavet jagada, kuid selgub, et dokumentatsioonis pole veel uut artiklit v\u00f5i t\u00f5lget. Selle t\u00f5ttu oleme isegi pidanud v\u00e4ljaannet edasi l\u00fckkama. Saame nii palju kui tahes paluda k\u00f5igil \u00f5igel ajal \u00fclesanne tehnilistele kirjanikele edastada, kuid see ei toimi. Kui protsessi ei automatiseerita, kordub olukord.<\/p>\n<p>Oleme teinud muudatusi YouTrackis. Uue funktsiooni artikli kirjutamise \u00fclesanne langeb tehnilise kirjaniku toimetusse just siis, kui v\u00f5imalusi hakatakse katsetama. Sel hetkel saab sellest teada ka turundus, et valmistuda reklaamimiseks. Teated tulevad ka ettev\u00f5tte sisemisse suhtlusrakendusse Mattermost, nii et arendajatelt uudiseid lihtsalt ei saa vahele j\u00e4tta.<\/p>\n<h3>Dokumentatsioon ei kajasta kasutajate vajadusi<\/h3>\n<p>\nOleme harjunud t\u00f6\u00f6tama nii: funktsioon on v\u00e4lja antud, siis r\u00e4\u00e4gime sellest. Kirjeldame, kuidas seda sisse ja v\u00e4lja l\u00fclitada, teha peeneid seadistusi. Aga mis juhtub, kui klient kasutab meie tarkvara viisil, mida me ei ole ette n\u00e4inud? V\u00f5i kui tal tekivad vead, millele me ei ole m\u00f5elnud?<\/p>\n<p>Dokumendi maksimaalse t\u00e4psuse tagamiseks soovitame anal\u00fc\u00fcsida tugiteenuste p\u00e4ringuid, teemasid foorumites ja otsingup\u00e4ringute soovitusi. K\u00f5ige populaarsemad teemad tuleks edastada tehnilise dokumentatsiooni autoritele, et nad saaksid olemasolevaid artikleid t\u00e4iendada v\u00f5i kirjutada uusi.<\/p>\n<h3>Dokumentatsiooni ei arendata edasi<\/h3>\n<p>\nOn keeruline saavutada t\u00e4iuslikkust kohe, vigu ikka esineb. Saame loota klientide tagasisidele, kuid t\u00f5en\u00e4oliselt ei teata nad igast tr\u00fckiveast, ebat\u00e4psusest v\u00f5i ebaselgest v\u00f5i leitud artiklist. Lisaks klientidele loevad dokumentatsiooni ka t\u00f6\u00f6tajad, mis t\u00e4hendab, et nad m\u00e4rkavad samu vigu. Seda saab \u00e4ra kasutada! Peame lihtsalt looma tingimused, kus probleemidest on lihtne teada anda.<\/p>\n<p>Meil on siseportaalis grupp, kus t\u00f6\u00f6tajad j\u00e4tavad m\u00e4rkuseid, ettepanekuid ja ideid dokumentatsiooni osas. Kas toimetusele on vajalik artikkel, aga seda pole? Testija m\u00e4rkis ebat\u00e4psuse? Partner kaebas arendusjuhtidele vigade p\u00e4rast? K\u00f5ik on siin grupis! Tehnilised kirjutajad teevad midagi kohe \u00e4ra, m\u00f5ned asjad kantakse YouTracki, m\u00f5ned v\u00f5etakse arutlusele. Et teema ei ununeks, tuletame aeg-ajalt meelde grupi olemasolu ja tagasiside t\u00e4htsust.<\/p>\n<h2>Probleem 3. Vajalikku artiklit peab kaua otsima<\/h2>\n<p>\nArtikkel, mida ei leia, ei ole parem kui artikkel, mida \u00fcldse ei ole. Hea dokumentatsiooni moto peaks olema lause \u201eLihtne otsida, lihtne leida\u201c. Kuidas seda saavutada?<\/p>\n<p><b>Korrastada struktuur ja m\u00e4\u00e4ratleda teema valimise printsiip<\/b>. Struktuur peab olema v\u00f5imalikult l\u00e4bipaistev, et lugeja ei m\u00f5tleks, \u201eKus ma saan seda artiklit leida?\u201c. Kui \u00fcldistada, siis on olemas kaks l\u00e4henemist: kasutajaliidesest ja \u00fclesannetest.<\/p>\n<ol>\n<li>Kasutajaliidesest. Sisu dubleerib paneeli jaotisi. Nii oli vanas ISPsystemi dokumentatsioonis.<\/li>\n<li>Kasutajate \u00fclesanded. Artiklite ja sektsioonide nimed peegeldavad kasutajate vajadusi; pealkirjades on peaaegu alati verbe ja vastuseid k\u00fcsimusele \u201ekuidas teha\u201d. N\u00fc\u00fcd liigume sellise formaadi suunas.<\/li>\n<\/ol>\n<p>\nMillist l\u00e4henemist te ka ei valiks, veenduge, et teema vastab kasutajate p\u00e4ringutele ja on k\u00e4sitletud viisil, et kasutaja saaks oma k\u00fcsimusele selgelt vastuse.<\/p>\n<p><b>Keskse otsingu seadistamine<\/b>. Ideaaltingimustes peaks otsing toimima isegi siis, kui teete tr\u00fckivigu v\u00f5i valite vale keele. Meie otsing Confluences seda kahjuks veel ei v\u00f5imalda. Kui teil on palju tooteid ja dokumentatsioon on \u00fchine, kohandage otsing lehe j\u00e4rgi, kus kasutaja asub. Meie puhul t\u00f6\u00f6tab otsing peamiselt k\u00f5igi toodete peale ja kui te juba olete konkreetses jaotises, siis ainult selle sektsiooni artiklite leidmiseks.<\/p>\n<p><b>Lisa sisu ja \u201eleivaosutused\u201d<\/b>. Igal lehel on hea, kui on men\u00fc\u00fc ja leivaosutused \u2014 kasutaja tee hetke leheni v\u00f5imalusega taganeda igal tasemel. ISPsystemi vanas dokumentatsioonis pidi artiklist lahkuma, et p\u00e4\u00e4seda sisule. See oli ebamugav, seega oleme uues seda parandanud.<\/p>\n<p><b>Seada lingid tootesse<\/b>. Kui inimesed tulevad korduvalt tugiteenusesse sama k\u00fcsimusega, on m\u00f5istlik lisada sellega seotud vihje kasutajaliidesesse. Kui teil on andmed v\u00f5i arusaam, millal kasutaja probleemiga silmitsi seisab, v\u00f5ite teda ka teavitada uudiskirjaga. Nii n\u00e4itate hoolivust ning v\u00e4hendate tugikoormust.<\/p>\n<p><img decoding=\"async\" alt=\"Kasutajate dokumentatsioon: mis teeb selle kehvaks ja kuidas seda parandada\" src=\"\/wp-content\/uploads\/2019\/03\/ddf030647cf3271e0e34924ff5c8116f.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<i>Paremal h\u00fcpikaknas on link DNSSEC-i seadistamise artiklile ISPmanageri domeeni haldamise jaotises.<\/i><\/p>\n<p><b>Seadistage ristlingid dokumentatsiooni sees.<\/b>. Artiklid, mis omavahel seotud, peaksid olema 'lingitud'. Kui artiklid on j\u00e4rjestikused, lisage kindlasti iga teksti l\u00f5ppu nooled edasi ja tagasi.<\/p>\n<blockquote><p>T\u00f5en\u00e4oliselt otsib inimene esmalt vastust oma k\u00fcsimusele mitte teilt, vaid otsingumootorist. On kahetsusv\u00e4\u00e4rne, kui seal ei ole tehnilistel p\u00f5hjustel linke dokumentatsioonile. Seega hoolitsege otsingumootori optimeerimise eest.<\/p><\/blockquote>\n<p><\/p>\n<h2>Probleem 4. Ahnud kujundus h\u00e4irib tajumist.<\/h2>\n<p>\nHalbadest tekstist v\u00f5ib dokumentatsiooni rikuda ka disain. Inimesed on harjunud lugema h\u00e4sti vormindatud materjale. Blogid, sotsiaalmeedia, meedia \u2014 kogu sisu esitatakse mitte ainult ilusana, vaid ka lugemismugavust silmas pidades. Seet\u00f5ttu on kerge m\u00f5ista valu, mida tunneb inimene, kes n\u00e4eb teksti nagu alloleval ekraanipildil. <\/p>\n<p><noindex><a rel=\"nofollow\" href=\"https:\/\/hsto.org\/webt\/en\/8-\/3q\/en8-3qj_jpwfiie91efwo_igqtk.png\"><img decoding=\"async\" alt=\"Kasutajate dokumentatsioon: mis teeb selle kehvaks ja kuidas seda parandada\" src=\"\/wp-content\/uploads\/2019\/03\/0a0762670770950d062e1cd4c0f33f1d.jpeg\" style=\"display:block;margin: 0 auto;\" \/><\/a><\/noindex><br \/>\n<i>Selles artiklis on ekraanipilte ja esilet\u00f5stmisi nii palju, et need ei aita, vaid segavad arusaamist (pilt on klikitav).<\/i><\/p>\n<p>\u00c4rge tehke dokumentatsioonist pikka lugemist, kus on palju efekte, kuid p\u00f5hireeglid tuleks siiski silmas pidada. <\/p>\n<p><b>Vormindamine<\/b>. M\u00e4\u00e4rake p\u00f5hiteksti laius, font, suurus, pealkirjad ja marginaalid. Kaasake disainer, ja kui soovite t\u00f6\u00f6d vastu v\u00f5tta v\u00f5i iseseisvalt hakkama saada, lugege Artem Gorbunovi raamatut \u201eT\u00fcpsus ja vormindamine\u201c. Selles on esitatud ainult \u00fcks vaatenurk vormindamise kohta, kuid see on t\u00e4iesti piisav.<\/p>\n<p><b>Esilet\u00f5stmised<\/b>. M\u00e4\u00e4rake, millised tekstielemendid vajavad r\u00f5hutamist. \u00dcldiselt on need liideses, nupud, koodijupid, konfiguratsioonifailid, samuti 'Pange t\u00e4hele' blokid. Otsustage, kuidas need elemendid esitatakse ja fikseerige see \u00f5igusaktides. Pidage meeles, et v\u00e4hem r\u00f5hutusi on paremad. Kui neid on liiga palju, muudab tekst 'm\u00fcraks'. M\u00fcra tekitavad isegi jutum\u00e4rgid, kui neid kasutatakse liiga sageli.<\/p>\n<p><b>Ekraanipildid<\/b>. Leppige meeskonnaga kokku, millal on vajalikud ekraanipildid. Iga sammu illustreerimine pole tingimata vajalik. Suur hulk ekraanipilte, sealhulgas individuaalsed nupud, kahjustavad arusaamist ja rikuvad kujundust. M\u00e4\u00e4rake ekraanipiltide r\u00f5hutuste ja pealkirjade suurus ning formaat ning fikseerige see \u00f5igusaktides. Pidage meeles, et illustratsioonid peavad alati vastama kirjutatule ja olema ajakohased. J\u00e4lle, kui toodet uuendatakse regulaarselt, on iga\u00fche j\u00e4lgimine keeruline.<\/p>\n<p><b>Teksti pikkus<\/b>. V\u00e4ltige liiga pikki artikleid. Jagage need osadeks, ja kui see ei ole v\u00f5imalik, lisage artikli algusesse sisu koos ankrulinkidega. Lihtne viis, kuidas muuta artikkel visuaalselt l\u00fchemaks, on peita tehnilised \u00fcksikasjad, mis on vajalikud kitsale lugejaskonnale, spoilerikasti alla.<\/p>\n<p><b>Formaadid<\/b>. \u00dchendage artiklites mitu formaati: tekst, video ja pildid. See parandab tajumist. <\/p>\n<blockquote><p>\u00c4rge proovige probleeme ilusate kujundustega varjata. Ausalt \u00f6eldes lootsime isegi, et \"\u00fcmbris\" p\u00e4\u00e4stab aegunud dokumentatsiooni \u2014 aga see ei t\u00f6\u00f6tanud. Tekstides oli liiga palju visuaalset m\u00fcra ja tarbetut teavet, mist\u00f5ttu uus regulatsioon ja kujundus olid j\u00f5uetud.<\/p><\/blockquote>\n<p>\nPalju sellest, mis eespool on kirjeldatud, m\u00e4\u00e4rab platvorm, mida kasutate dokumentatsiooniks. Meil on n\u00e4iteks Confluence. Sellega tuli ka vaeva n\u00e4ha. Kui see huvitab, lugege meie veebiarendaja lugu: <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/438236\/\">Confluence avaliku teadmistebaasi jaoks: kujunduse muutmine ja keelte jagamise seadistamine<\/a><\/noindex>.<\/p>\n<h2>Kust alustada paranemist ja kuidas ellu j\u00e4\u00e4da<\/h2>\n<p>\nKui teie dokumentatsioon on sama mahukas kui ISPsystemi oma ja ei tea, kust alustada, keskenduge k\u00f5ige t\u00f5sisematele probleemidele. Klientidele ei ole dokumendid arusaadavad \u2014 tegelege tekstide parandamisega, looge reeglid, koolitage kirjanikke. Dokumentatsioon on aegunud \u2014 v\u00f5tke k\u00e4sile sisemised protsessid. Alustage k\u00f5ige populaarsematest artiklitest enim n\u00f5utud toodete kohta: k\u00fcsige tugiteenuseks, vaadake veebianal\u00fc\u00fctikat ja otsingup\u00e4ringute allikaid. <\/p>\n<p>\u00dctleme kohe - kerge see ei ole. Ja kiiresti ka t\u00f5en\u00e4oliselt ei \u00f5nnestu. Juhul kui te just alustate ja teete kohe \u00f5igesti. \u00dcks asi on kindel \u2014 aja jooksul l\u00e4heb paremaks. Kuid see protsess ei l\u00f5ppe kunagi :-).<\/p>\n<p>Allikas: <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-novosti-interneta"],"aioseo_notices":[],"aioseo_head":"\n\t\t<!-- All in One SEO 4.9.10 - aioseo.com -->\n\t<meta name=\"description\" content=\"\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\" \/>\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\/et\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit\" \/>\n\t<meta name=\"generator\" content=\"All in One SEO (AIOSEO) 4.9.10\" \/>\n\t\t<meta property=\"og:locale\" content=\"et_EE\" \/>\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 \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\" \/>\n\t\t<meta property=\"og:url\" content=\"https:\/\/prohoster.info\/et\/blog\/novosti-interneta\/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\udd47Kasutaja dokumentatsioon: mis teeb selle halvaks ja kuidas seda parandada | ProHoster","description":"Tarkvara dokumentatsioon on lihtsalt artiklite kogum. Kuid isegi need v\u00f5ivad t\u00fc\u00fcdata. Esiteks otsite kaua vajalikke juhiseid. Siis \u00fcritate m\u00f5ista keerulist teksti. Teete nagu on kirjutatud, kuid probleem ei lahene. Otsite teist artiklit, \u00e4rritate... Tunni jooksul viskate k\u00f5ik nurka ja lahkute. Nii toimib halb dokumentatsioon. Mis teeb selle selliseks ja kuidas seda parandada.","canonical_url":"https:\/\/prohoster.info\/et\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":null,"og:locale":"et_EE","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 \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","og:url":"https:\/\/prohoster.info\/et\/blog\/novosti-interneta\/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"},"gt_translate_keys":[{"key":"link","format":"url"}],"_links":{"self":[{"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/posts\/42119","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/comments?post=42119"}],"version-history":[{"count":0,"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/posts\/42119\/revisions"}],"wp:attachment":[{"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/media?parent=42119"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/categories?post=42119"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/prohoster.info\/et\/wp-json\/wp\/v2\/tags?post=42119"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}