{"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\/hu\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","title":{"rendered":"Felhaszn\u00e1l\u00f3i dokument\u00e1ci\u00f3: mi\u00e9rt rossz, \u00e9s hogyan lehet jav\u00edtani?","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"<p><img decoding=\"async\" alt=\"Felhaszn\u00e1l\u00f3i dokument\u00e1ci\u00f3: mi\u00e9rt rossz, \u00e9s hogyan lehet jav\u00edtani?\" src=\"\/wp-content\/uploads\/2019\/03\/4381d63e81fbb299384255cb54dd34b5.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<br \/>\nA szoftver dokument\u00e1ci\u00f3ja csup\u00e1n egy cikkekb\u0151l \u00e1ll\u00f3 gy\u0171jtem\u00e9ny. De ezeket is ki tudj\u00e1k kergetni a vil\u00e1gb\u00f3l. El\u0151sz\u00f6r sok\u00e1ig keresed a sz\u00fcks\u00e9ges \u00fatmutat\u00f3t. Azt\u00e1n pr\u00f3b\u00e1lod meg\u00e9rteni a nehezen \u00e9rthet\u0151 sz\u00f6veget. Azt csin\u00e1lod, amit \u00edrtak, de a probl\u00e9ma nem old\u00f3dik meg. M\u00e1sik cikket keresel, idegeskedsz... Egy \u00f3ra m\u00falva pedig feladod, \u00e9s t\u00e1vozol. \u00cdgy m\u0171k\u00f6dik a rossz dokument\u00e1ci\u00f3. Mi teszi ilyenn\u00e9, \u00e9s hogyan lehet ezt megjav\u00edtani \u2014 olvasd el lentebb.<br \/>\n<noindex><a rel=\"nofollow\" name=\"habracut\"><\/a><\/noindex><\/p>\n<blockquote><p>A r\u00e9gi dokument\u00e1ci\u00f3nknak sok hi\u00e1nyoss\u00e1ga volt. M\u00e1r k\u00f6zel egy \u00e9ve \u00e1tdolgozzuk, hogy a fent le\u00edrt forgat\u00f3k\u00f6nyv ne \u00e9rintse \u00fcgyfeleinket. N\u00e9zd meg, <noindex><a rel=\"nofollow\" href=\"https:\/\/doc.ispsystem.ru\/index.php\/\">hogy volt<\/a><\/noindex> \u00e9s <noindex><a rel=\"nofollow\" href=\"https:\/\/docs.ispsystem.ru\/\">hogy lett<\/a><\/noindex>.<\/p><\/blockquote>\n<p><\/p>\n<h2>1. probl\u00e9ma: Nehezen \u00e9rthet\u0151, rosszul meg\u00edrt cikkek<\/h2>\n<p>\nHa a dokument\u00e1ci\u00f3ban nem lehet meg\u00e9rteni, mi \u00e9rtelme van? De senki sem \u00edr sz\u00e1nd\u00e9kosan nehezen \u00e9rthet\u0151 cikkeket. Ezek abb\u00f3l ad\u00f3dnak, amikor a szerz\u0151 nem gondol az olvas\u00f3kra \u00e9s a c\u00e9lra, \u00edzl\u00e9stelens\u00e9geket \u00edr, \u00e9s nem ellen\u0151rzi a sz\u00f6veget a hib\u00e1k miatt.<\/p>\n<ul>\n<li><b>Olvas\u00f3i k\u00f6z\u00f6ns\u00e9g<\/b>. Cikk \u00edr\u00e1sa el\u0151tt figyelembe kell venni az olvas\u00f3k tud\u00e1sszintj\u00e9t. Logikus, hogy egy kezd\u0151knek sz\u00f3l\u00f3 cikkben nem hagyhat\u00f3k ki az alapl\u00e9p\u00e9sek, \u00e9s a technikai kifejez\u00e9seket nem szabad magyar\u00e1zat n\u00e9lk\u00fcl hagyni, m\u00edg egy ritka funkci\u00f3val foglalkoz\u00f3 szakmai cikkben \u00e9rdemes kib\u0151v\u00edteni a PHP sz\u00f3 jelent\u00e9s\u00e9t.<\/li>\n<li><b>C\u00e9l<\/b>. Tov\u00e1bbi fontos dolog, amivel \u00e9rdemes el\u0151re foglalkozni. A szerz\u0151nek vil\u00e1gos c\u00e9lt kell kit\u0171znie, meg kell hat\u00e1roznia a cikk hasznos cselekv\u00e9s\u00e9t, \u00e9s el kell d\u00f6ntenie, mit fog tenni az olvas\u00f3 a cikk elolvas\u00e1sa ut\u00e1n. Ha ezt nem teszik meg, a cikk le\u00edr\u00e1sa csup\u00e1n le\u00edr\u00e1s marad. <\/li>\n<li><b>Felesleges inform\u00e1ci\u00f3k \u00e9s hib\u00e1k<\/b>. Sok felesleges inform\u00e1ci\u00f3 \u00e9s hivatalos nyelvezet, hib\u00e1k \u00e9s elg\u00e9pel\u00e9sek rontj\u00e1k a meg\u00e9rt\u00e9st. M\u00e9g ha az olvas\u00f3 nem is nyelvtan spicli, a hanyags\u00e1g a sz\u00f6vegben elriaszthatja.<\/li>\n<\/ul>\n<p>\nVedd figyelembe a fenti tan\u00e1csokat, \u00e9s a cikkek vil\u00e1gosabb\u00e1 v\u00e1lnak \u2014 garant\u00e1ljuk. Ha m\u00e9g jobbat szeretn\u00e9l csin\u00e1lni, haszn\u00e1ld a <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/431456\/\"> 50 k\u00e9rd\u00e9st a technikai dokument\u00e1ci\u00f3val val\u00f3 munk\u00e1hoz<\/a><\/noindex>.<\/p>\n<h2>2. probl\u00e9ma: A cikkek nem v\u00e1laszolnak minden k\u00e9rd\u00e9sre<\/h2>\n<p>\nRossz, ha a dokument\u00e1ci\u00f3 nem tart l\u00e9p\u00e9st a fejleszt\u00e9ssel, nem v\u00e1laszol a val\u00f3s k\u00e9rd\u00e9sekre, a benne l\u00e9v\u0151 hib\u00e1k \u00e9vekig megoldatlanok maradnak. Ezek a probl\u00e9m\u00e1k nem annyira a szerz\u0151 felel\u0151ss\u00e9ge, hanem a v\u00e1llalaton bel\u00fcli folyamatok szervez\u00e9s\u00e9nek.<\/p>\n<h3>A dokument\u00e1ci\u00f3 nem tart l\u00e9p\u00e9st a fejleszt\u00e9ssel<\/h3>\n<p>\nA funkci\u00f3 m\u00e1r el\u00e9rhet\u0151, a marketing tervezi, hogy nyilv\u00e1noss\u00e1gra hozza, \u00e9s ek\u00f6zben kider\u00fcl, hogy a dokument\u00e1ci\u00f3ban m\u00e9g mindig nincs \u00faj cikk vagy ford\u00edt\u00e1s. Emiatt n\u00e9ha el kellett halasztanunk a kiad\u00e1st. Ak\u00e1rmennyit k\u00e9rj\u00fck is mindenkit, hogy id\u0151ben adj\u00e1k \u00e1t a feladatot a m\u0171szaki \u00edr\u00f3knak, ez nem fog m\u0171k\u00f6dni. Ha a folyamatot nem automatiz\u00e1ljuk, a helyzet meg fog ism\u00e9tl\u0151dni.<\/p>\n<p>V\u00e1ltoztat\u00e1sokat hajtottunk v\u00e9gre a YouTrack-en. A feladat, hogy cikket \u00edrjunk az \u00faj funkci\u00f3r\u00f3l, abban a pillanatban \u00e9rkezik a m\u0171szaki \u00edr\u00f3hoz, amikor a lehet\u0151s\u00e9geket tesztelni kezdik. Ekkor a marketing is \u00e9rtes\u00fcl r\u00f3la, hogy felk\u00e9sz\u00fclhessen a prom\u00f3ci\u00f3ra. Az \u00e9rtes\u00edt\u00e9sek a v\u00e1llalati Messenger, a Mattermost seg\u00edts\u00e9g\u00e9vel is meg\u00e9rkeznek, \u00edgy egyszer\u0171en lehetetlen lek\u00e9sni a fejleszt\u0151kt\u0151l \u00e9rkez\u0151 h\u00edreket.<\/p>\n<h3>A dokument\u00e1ci\u00f3 nem t\u00fckr\u00f6zi a felhaszn\u00e1l\u00f3i ig\u00e9nyeket<\/h3>\n<p>\nHozz\u00e1szoktunk ahhoz, hogy \u00edgy dolgozunk: a funkci\u00f3 megjelent, mi besz\u00e1moltunk r\u00f3la. Le\u00edrtuk, hogyan aktiv\u00e1lhat\u00f3, deaktiv\u00e1lhat\u00f3, \u00e9s hogyan v\u00e9gezhet\u0151 el a finomhangol\u00e1s. De mi van akkor, ha az \u00fcgyf\u00e9l \u00fagy haszn\u00e1lja a szoftver\u00fcnket, ahogy nem is gondoltuk? Vagy hib\u00e1k mer\u00fclnek fel, amelyekre nem gondoltunk?<\/p>\n<p>Ahhoz, hogy a dokument\u00e1ci\u00f3 a lehet\u0151 legteljesebb legyen, aj\u00e1nlott elemezni a t\u00e1mogat\u00e1si k\u00e9r\u00e9seket, a tematikus f\u00f3rumokon feltett k\u00e9rd\u00e9seket, a keres\u0151kben leadott keres\u00e9seket. A legn\u00e9pszer\u0171bb t\u00e9m\u00e1kat \u00e1t kell adni a m\u0171szaki \u00edr\u00f3knak, hogy kieg\u00e9sz\u00edts\u00e9k a megl\u00e9v\u0151 cikkeket vagy \u00fajakat \u00edrjanak.<\/p>\n<h3>A dokument\u00e1ci\u00f3 nem fejl\u0151dik<\/h3>\n<p>\nNeh\u00e9z mindent egyszerre t\u00f6k\u00e9letesen megcsin\u00e1lni, hib\u00e1k \u00edgy is lesznek. Lehet b\u00edzni a visszajelz\u00e9sekben az \u00fcgyfelekt\u0151l, de val\u00f3sz\u00edn\u0171, hogy nem fognak minden el\u00edr\u00e1sr\u00f3l, pontatlans\u00e1gr\u00f3l, \u00e9rthetetlen vagy meg nem tal\u00e1lhat\u00f3 cikkr\u0151l besz\u00e1molni. Az \u00fcgyfeleken k\u00edv\u00fcl a dokument\u00e1ci\u00f3t az alkalmazottak is olvass\u00e1k, teh\u00e1t \u0151k is l\u00e1tj\u00e1k ezeket a hib\u00e1kat. Ezt kihaszn\u00e1lhatjuk! Csak olyan k\u00f6r\u00fclm\u00e9nyeket kell l\u00e9trehozni, amelyekben k\u00f6nnyen be lehet sz\u00e1molni a probl\u00e9m\u00e1r\u00f3l.<\/p>\n<p>Van egy csoportunk a bels\u0151 port\u00e1lon, ahol az alkalmazottak megjegyz\u00e9seket, javaslatokat \u00e9s \u00f6tleteket adhatnak a dokument\u00e1ci\u00f3val kapcsolatban. Sz\u00fcks\u00e9g van egy cikkre, de az nincs? A tesztel\u0151 \u00e9szrevett egy pontatlans\u00e1got? A partner a fejleszt\u00e9si menedzsereken kereszt\u00fcl panaszt tett a hib\u00e1k miatt? Mindez ebbe a csoportba! A m\u0171szaki \u00edr\u00f3k azonnal jav\u00edtanak valamit, \u00e1tvisznek dolgokat a YouTrack-ra, vagy elgondolkodnak rajtuk. Hogy a t\u00e9ma ne s\u00fcllyedjen el, id\u0151nk\u00e9nt eml\u00e9keztetj\u00fck \u0151ket a csoport l\u00e9tez\u00e9s\u00e9re \u00e9s a visszajelz\u00e9s fontoss\u00e1g\u00e1ra.<\/p>\n<h2>3. probl\u00e9ma. A sz\u00fcks\u00e9ges cikket sok\u00e1ig keresni kell<\/h2>\n<p>\nEgy cikk, amit nem lehet megtal\u00e1lni, semmiben sem jobb, mint egy cikk, ami nem l\u00e9tezik. A j\u00f3 dokument\u00e1ci\u00f3 mott\u00f3ja legyen a \u201eK\u00f6nnyen kereshet\u0151, k\u00f6nnyen megtal\u00e1lhat\u00f3\u201d kifejez\u00e9s. Hogyan \u00e9rj\u00fck el ezt?<\/p>\n<p><b>Rendezze strukt\u00far\u00e1j\u00e1t \u00e9s hat\u00e1rozza meg a t\u00e9ma v\u00e1laszt\u00e1s\u00e1nak elveit<\/b>. A strukt\u00far\u00e1nak a lehet\u0151 legegys\u00e9gesebbnek kell lennie, hogy az olvas\u00f3 ne gondolkodjon azon, hogy \u201eHol tal\u00e1lom ezt a cikket?\u201d. \u00d6sszess\u00e9g\u00e9ben k\u00e9t megk\u00f6zel\u00edt\u00e9s l\u00e9tezik: az interf\u00e9sz \u00e9s a feladatok szerint.<\/p>\n<ol>\n<li>Az interf\u00e9szb\u0151l. A tartalom megism\u00e9tli a panel szekci\u00f3it. \u00cdgy volt ez az ISPsystem r\u00e9gi dokument\u00e1ci\u00f3j\u00e1ban.<\/li>\n<li>A feladatokb\u00f3l. A cikkek \u00e9s szekci\u00f3k nevei t\u00fckr\u00f6zik a felhaszn\u00e1l\u00f3k feladatait; a c\u00edmekben szinte mindig vannak ig\u00e9k \u00e9s v\u00e1laszok arra a k\u00e9rd\u00e9sre, hogy \u201ehogyan kell elv\u00e9gezni\u201d. Jelenleg \u00e1tt\u00e9r\u00fcnk erre a form\u00e1tumra.<\/li>\n<\/ol>\n<p>\nB\u00e1rmilyen megk\u00f6zel\u00edt\u00e9st is v\u00e1laszt, gy\u0151z\u0151dj\u00f6n meg r\u00f3la, hogy a t\u00e9ma megfelel a felhaszn\u00e1l\u00f3k k\u00e9rd\u00e9seinek, \u00e9s \u00fagy van k\u00f6r\u00fcl\u00edrva, hogy a felhaszn\u00e1l\u00f3 biztosan megoldja a probl\u00e9m\u00e1j\u00e1t.<\/p>\n<p><b>K\u00f6zpontos\u00edtott keres\u00e9s be\u00e1ll\u00edt\u00e1sa<\/b>. Az ide\u00e1lis vil\u00e1gban a keres\u00e9snek m\u0171k\u00f6dnie kell, m\u00e9g akkor is, ha hib\u00e1zik az \u00edr\u00e1sban vagy a nyelvben. A Confluence-ban a keres\u00e9s\u00fcnk m\u00e9g nem tud ezzel \u00f6r\u00f6met szerezni. Ha sok term\u00e9ke van, \u00e9s a dokument\u00e1ci\u00f3 \u00e1ltal\u00e1nos, igaz\u00edtsa a keres\u00e9st ahhoz az oldalhoz, ahol a felhaszn\u00e1l\u00f3 tart\u00f3zkodik. A mi eset\u00fcnkben a f\u0151oldalon a keres\u00e9s minden term\u00e9kre m\u0171k\u00f6dik, de ha m\u00e1r egy adott szekci\u00f3ban van, akkor csak a benne l\u00e9v\u0151 cikkekre korl\u00e1toz\u00f3dik.<\/p>\n<p><b>Tartalom \u00e9s \u201ekeny\u00e9rmorzs\u00e1k\u201d hozz\u00e1ad\u00e1sa<\/b>. J\u00f3, ha minden oldalon van men\u00fc \u00e9s keny\u00e9rmorzs\u00e1k \u2014 a felhaszn\u00e1l\u00f3 \u00fatja az aktu\u00e1lis oldalhoz, lehet\u0151s\u00e9ggel, hogy visszat\u00e9rjen b\u00e1rmelyik szintre. Az ISPsystem r\u00e9gi dokument\u00e1ci\u00f3j\u00e1ban ki kellett l\u00e9pni a cikkb\u0151l, hogy el\u00e9rj\u00fck a tartalmi list\u00e1t. Ez k\u00e9nyelmetlen volt, ez\u00e9rt a \u00fajn\u00e1l ezt kijav\u00edtottuk.<\/p>\n<p><b>Hozza l\u00e9tre a hivatkoz\u00e1sokat a term\u00e9kben<\/b>. Ha az emberek \u00fajra \u00e9s \u00fajra ugyanazzal a k\u00e9rd\u00e9ssel keresnek t\u00e1mogat\u00e1st, \u00e9rdemes egy javaslatot hozz\u00e1adni a felhaszn\u00e1l\u00f3i fel\u00fclethez a megold\u00e1ssal. Ha vannak adatai vagy meg\u00e9rt\u00e9se arr\u00f3l, hogy a felhaszn\u00e1l\u00f3 mikor tal\u00e1lkozik probl\u00e9m\u00e1val, akkor \u00e9rtes\u00edtheti \u0151t h\u00edrlev\u00e9llel is. Ezzel gondoskodik r\u00f3la, \u00e9s leveszi a terhet a t\u00e1mogat\u00e1sr\u00f3l.<\/p>\n<p><img decoding=\"async\" alt=\"Felhaszn\u00e1l\u00f3i dokument\u00e1ci\u00f3: mi\u00e9rt rossz, \u00e9s hogyan lehet jav\u00edtani?\" src=\"\/wp-content\/uploads\/2019\/03\/ddf030647cf3271e0e34924ff5c8116f.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<i>Jobbra az ugr\u00f3ablakban van egy hivatkoz\u00e1s a DNSSEC be\u00e1ll\u00edt\u00e1s\u00e1r\u00f3l sz\u00f3l\u00f3 cikkre az ISPmanager domainkezel\u0151 szekci\u00f3j\u00e1ban<\/i><\/p>\n<p><b>\u00c1ll\u00edtson be keresztlinkeket a dokument\u00e1ci\u00f3ban<\/b>A cikkek, amelyek \u00f6sszef\u00fcgg\u00e9sben \u00e1llnak egym\u00e1ssal, 'linkelni' kell. Ha a cikkek egy sorozatot alkotnak, mindenk\u00e9ppen adjunk minden sz\u00f6veg v\u00e9g\u00e9re el\u0151re \u00e9s h\u00e1tra mutat\u00f3 nyilakat.<\/p>\n<blockquote><p>Val\u00f3sz\u00edn\u0171, hogy az ember el\u0151sz\u00f6r nem n\u00e1lad keresi a k\u00e9rd\u00e9s\u00e9re a v\u00e1laszt, hanem a keres\u0151ben. Beteges, ha technikai okokb\u00f3l nincsenek linkek a dokument\u00e1ci\u00f3hoz. Teh\u00e1t gondoskodj a keres\u0151optimaliz\u00e1l\u00e1sr\u00f3l.<\/p><\/blockquote>\n<p><\/p>\n<h2>4. probl\u00e9ma. Elavult t\u00f6rdel\u00e9s zavarja az \u00e9szlel\u00e9st<\/h2>\n<p>\nA rossz sz\u00f6vegek mellett a dokument\u00e1ci\u00f3t a diz\u00e1jn is meg tudja rontani. Az emberek megszokt\u00e1k, hogy j\u00f3l t\u00f6rdel\u0151d\u0151 anyagokat olvasnak. A blogok, k\u00f6z\u00f6ss\u00e9gi oldalak, m\u00e9di\u00e1k \u2014 az \u00f6sszes tartalom nemcsak sz\u00e9p, hanem olvas\u00f3bar\u00e1t is. Ez\u00e9rt k\u00f6nnyen meg\u00e9rthetj\u00fck azt a f\u00e1jdalm\u00e1t annak, aki sz\u00f6veget l\u00e1t, mint az al\u00e1bbi k\u00e9pen. <\/p>\n<p><noindex><a rel=\"nofollow\" href=\"https:\/\/hsto.org\/webt\/en\/8-\/3q\/en8-3qj_jpwfiie91efwo_igqtk.png\"><img decoding=\"async\" alt=\"Felhaszn\u00e1l\u00f3i dokument\u00e1ci\u00f3: mi\u00e9rt rossz, \u00e9s hogyan lehet jav\u00edtani?\" src=\"\/wp-content\/uploads\/2019\/03\/0a0762670770950d062e1cd4c0f33f1d.jpeg\" style=\"display:block;margin: 0 auto;\" \/><\/a><\/noindex><br \/>\n<i>Ebben a cikkben annyira sok a k\u00e9perny\u0151k\u00e9p \u00e9s a kiemel\u00e9s, hogy azok nem seg\u00edtenek, hanem csak zavarj\u00e1k az \u00e9szlel\u00e9st (a k\u00e9p kattinthat\u00f3)<\/i><\/p>\n<p>Nem szabad a dokument\u00e1ci\u00f3b\u00f3l hossz\u00fa olvasm\u00e1nyt csin\u00e1lni sok effektussal, de az alapvet\u0151 szab\u00e1lyokat figyelembe kell venni. <\/p>\n<p><b>T\u00f6rdel\u00e9s<\/b>. Hat\u00e1rozd meg a f\u0151 sz\u00f6veg sz\u00e9less\u00e9g\u00e9t, bet\u0171t\u00edpust, m\u00e9retet, c\u00edmsorokat \u00e9s marg\u00f3kat. Vonj be egy designerszakembert, \u00e9s ha elfogadod a munk\u00e1t, vagy \u00f6n\u00e1ll\u00f3an is meg tudod oldani, olvasd el Artyom Gorbnova \"Tipogr\u00e1fia \u00e9s t\u00f6rdel\u00e9s\" c\u00edm\u0171 k\u00f6nyv\u00e9t. Ez csak egy n\u00e9z\u0151pont a t\u00f6rdel\u00e9sr\u0151l, de teljesen el\u00e9g.<\/p>\n<p><b>Kiemel\u00e9sek<\/b>. Hat\u00e1rozd meg, mi ig\u00e9nyel hangs\u00falyt a sz\u00f6vegben. Ez \u00e1ltal\u00e1ban az interface-ben l\u00e9v\u0151 \u00fat, gombok, k\u00f3dbeilleszt\u00e9sek, konfigur\u00e1ci\u00f3s f\u00e1jlok, 'Figyelj' blokkok. Hat\u00e1rozd meg, hogy ezek az elemek hogyan legyenek kiemelve \u00e9s r\u00f6gz\u00edtsd a szab\u00e1lyzatban. Ne feledd, hogy min\u00e9l kevesebb kiemel\u00e9s, ann\u00e1l jobb. Ha sok van bel\u0151l\u00fck, a sz\u00f6veg zajos lesz. M\u00e9g a szavak is zajt okoznak, ha t\u00fal gyakran haszn\u00e1lj\u00e1k \u0151ket.<\/p>\n<p><b>K\u00e9perny\u0151k\u00e9pek<\/b>. Egyeztess a csapattal, mely esetekben sz\u00fcks\u00e9gesek a k\u00e9perny\u0151k\u00e9pek. Nincs sz\u00fcks\u00e9g minden l\u00e9p\u00e9s illusztr\u00e1l\u00e1s\u00e1ra. A sok k\u00e9perny\u0151k\u00e9p, bele\u00e9rtve az egyes gombokat is, zavarja az \u00e9szlel\u00e9st \u00e9s rontja a t\u00f6rdel\u00e9st. Hat\u00e1rozd meg a m\u00e9retet, valamint a kiemel\u00e9sek \u00e9s a feliratok form\u00e1tum\u00e1t a k\u00e9perny\u0151k\u00e9peken, r\u00f6gz\u00edtsd a szab\u00e1lyzatban. Ne feledd, hogy az illusztr\u00e1ci\u00f3knak mindig meg kell felelni\u00fck a le\u00edrtaknak \u00e9s aktu\u00e1lisnak kell lenni\u00fck. Megint csak, ha a term\u00e9k rendszeresen friss\u00fcl, neh\u00e9z lesz k\u00f6vetni mindent.<\/p>\n<p><b>A sz\u00f6veg hossza<\/b>. Ker\u00fclje el a t\u00fal hossz\u00fa cikkeket. T\u00f6rje \u0151ket r\u00e9szekre, \u00e9s ha ez lehetetlen, adjon hozz\u00e1 egy tartalomjegyz\u00e9ket horgonyz\u00f3 linkekkel a cikk elej\u00e9hez. Egy egyszer\u0171 m\u00f3dszer a cikk vizu\u00e1lis ler\u00f6vid\u00edt\u00e9s\u00e9re az, ha a m\u0171szaki r\u00e9szleteket, amelyek csak sz\u0171k k\u00f6r sz\u00e1m\u00e1ra relev\u00e1nsak, spoilerbe rejti.<\/p>\n<p><b>Form\u00e1tumok<\/b>. Kombin\u00e1ljon t\u00f6bb form\u00e1tumot a cikkekben: sz\u00f6veg, vide\u00f3 \u00e9s k\u00e9pek. Ez jav\u00edtja a meg\u00e9rt\u00e9st. <\/p>\n<blockquote><p>Ne pr\u00f3b\u00e1lkodjon a probl\u00e9m\u00e1k eltakar\u00e1s\u00e1val sz\u00e9p form\u00e1z\u00e1ssal. \u0150szint\u00e9n, mi is azt rem\u00e9lt\u00fck, hogy a \u201ecsomagol\u00e1s\u201d megmenti a elavult dokument\u00e1ci\u00f3t \u2013 de nem \u00edgy lett. A sz\u00f6vegekben annyi vizu\u00e1lis zaj \u00e9s felesleges r\u00e9szlet volt, hogy a norm\u00e1k \u00e9s az \u00faj form\u00e1tumok tehetetlenek voltak.<\/p><\/blockquote>\n<p>\nSok minden a fentiek k\u00f6z\u00fcl att\u00f3l f\u00fcgg, hogy mely platformot haszn\u00e1lja a dokument\u00e1ci\u00f3hoz. N\u00e1lunk p\u00e9ld\u00e1ul ez a Confluence. Ezen is dolgozni kellett. Ha \u00e9rdekli, olvassa el webfejleszt\u0151nk t\u00f6rt\u00e9net\u00e9t: <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/438236\/\">Confluence a nyilv\u00e1nos tud\u00e1sb\u00e1zis sz\u00e1m\u00e1ra: a diz\u00e1jn megv\u00e1ltoztat\u00e1sa \u00e9s a nyelvek szerinti feloszt\u00e1s be\u00e1ll\u00edt\u00e1sa<\/a><\/noindex>.<\/p>\n<h2>Honnan kezdj\u00fck a fejleszt\u00e9seket \u00e9s hogyan maradjunk \u00e9letben<\/h2>\n<p>\nHa a dokument\u00e1ci\u00f3ja olyan terjedelmes, mint az ISPsystem\u00e9, \u00e9s nem tudja, hol kezdje, a legkomolyabb probl\u00e9m\u00e1kkal kezdje. Ha az \u00fcgyfelek nem \u00e9rtik a dokument\u00e1ci\u00f3t \u2013 foglalkozzon a sz\u00f6vegek jav\u00edt\u00e1s\u00e1val, k\u00e9sz\u00edtsen norm\u00e1kat, k\u00e9pezze ki az \u00edr\u00f3kat. Ha a dokument\u00e1ci\u00f3 elavult \u2013 foglalkozzon a bels\u0151 folyamatokkal. Kezdje a legn\u00e9pszer\u0171bb cikkekkel a keresettebb term\u00e9kekr\u0151l: k\u00e9rdezze meg a t\u00e1mogat\u00e1st, n\u00e9zze meg a weboldal analitik\u00e1j\u00e1t \u00e9s a keres\u00e9si lek\u00e9rdez\u00e9seket. <\/p>\n<p>Azonnal mondjuk \u2013 nem lesz k\u00f6nny\u0171. \u00c9s val\u00f3sz\u00edn\u0171leg gyors sem. Kiv\u00e9ve, ha most kezd \u00e9s mindent az elej\u00e9t\u0151l j\u00f3l csin\u00e1l. Egy dolog biztos \u2013 az id\u0151 m\u00fal\u00e1s\u00e1val jobb lesz. De a folyamat sosem \u00e9r v\u00e9get :-).<\/p>\n<p>Forr\u00e1s: <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\/hu\/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=\"hu_HU\" \/>\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\/hu\/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\udd47Felhaszn\u00e1l\u00f3i dokument\u00e1ci\u00f3: mi\u00e9rt rossz, \u00e9s hogyan lehet jav\u00edtani | ProHoster","description":"Dokument\u00e1ci\u00f3 a.","canonical_url":"https:\/\/prohoster.info\/hu\/blog\/news\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":null,"og:locale":"hu_HU","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\/hu\/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\/hu\/wp-json\/wp\/v2\/posts\/42119","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/comments?post=42119"}],"version-history":[{"count":0,"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/posts\/42119\/revisions"}],"wp:attachment":[{"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/media?parent=42119"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/categories?post=42119"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/prohoster.info\/hu\/wp-json\/wp\/v2\/tags?post=42119"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}