Ҳуҷҷатҳои нармафзор танҳо маҷмӯи мақолаҳо мебошанд. Аммо ҳатто онҳо метавонанд шуморо девона кунанд. Аввалан, шумо дар ҷустуҷӯи дастурҳои зарурӣ муддати тӯлонӣ сарф мекунед. Он гоҳ шумо матни норавшанро мефаҳмед. Шумо тавре ки навиштаед, мекунед, аммо мушкилот ҳал нашудааст. Мақолаи дигар меҷӯй, асабонӣ мешавӣ... Пас аз як соат аз ҳама чиз даст мекашӣ ва меравӣ. Ин аст, ки ҳуҷҷатҳои бад кор мекунанд. Он чӣ гуна аст ва чӣ гуна онро ислоҳ кардан мумкин аст - дар зери бурида хонед.
Дар хуччатхои кухнаи мо камбудихо бисьёр буданд. Мо онро қариб як сол боз кор карда истодаем, то сенарияи дар боло тавсифшуда ба мизоҷони мо таъсир нарасонад. Нигоҳ кунед, и .
Мушкилоти 1: Мақолаҳои норавшан ва суст навишташуда
Агар ҳуҷҷатҳоро фаҳмидан ғайриимкон бошад, ин чӣ маъно дорад? Аммо касе дидаю дониста мақолаҳои нофаҳмо наменависад. Ондо вадте руй медиданд, ки муаллиф дар бораи тамошобин ва мадсад фикр намекунад, об мерезад ва дар матн хатодо намесанчад.
- Ҳозирини гиромӣ!. Пеш аз навиштани мақола, шумо бояд дар бораи сатҳи омодагии хонанда фикр кунед. Мантиқист, ки дар мақолае барои шурӯъкунандагон шумо набояд қадамҳои асосиро гузаред ва истилоҳҳои техникиро бидуни тавзеҳот тарк кунед, аммо дар мақолае дар бораи хусусияти нодире, ки танҳо ба мутахассисон лозим аст, шумо бояд маънои калимаи PHP-ро шарҳ диҳед.
- Мақсад. Боз як чизи дигарро пешакй фикр кардан лозим аст. Муаллиф бояд максади аник гузорад, самараи муфиди маколаро муайян кунад ва баъд аз мутолиаи он хонанда ба чй кор машгул шавад. Агар ин кор карда нашавад, шумо ба хотири тавсиф тавсиф хоҳед кард.
- Об ва ҳашарот. Бисьёр маълумоти нолозим ва бюрократизм, хатою хатогихо ба дарк халал мерасонанд. Ҳатто агар хонанда нози грамматик набошад ҳам, беэҳтиётӣ дар матн метавонад ӯро хомӯш кунад.
Маслиҳатҳои дар боло зикршударо баррасӣ кунед ва мақолаҳо равшантар хоҳанд шуд - кафолат дода мешавад. Барои беҳтар кардани он, мо истифода баред .
Масъалаи 2. Мақолаҳо ба ҳама саволҳо ҷавоб намедиҳанд
Ин бад аст, вақте ки ҳуҷҷатгузорӣ ба рушд мувофиқат намекунад, ба саволҳои воқеӣ ҷавоб намедиҳад ва хатогиҳо дар он солҳо ислоҳ карда намешаванд. Инҳо на бештар аз ҷониби муаллиф, балки мушкилоти ташкили равандҳои дохили ширкат мебошанд.
Ҳуҷҷатҳо ба рушд мувофиқат намекунанд
Хусусият аллакай нашр шудааст, маркетинг ба нақша гирифтааст, ки онро фаро гирад ва он гоҳ маълум мешавад, ки мақолаи нав ё тарҷума ҳанӯз дар ҳуҷҷатҳо мавҷуд нест. Аз ин сабаб мо ҳатто маҷбур шудем, ки озодшавиро ба таъхир андозем. Шумо метавонед аз ҳама хоҳиш кунед, ки вазифаҳоро ба нависандагони техникӣ дар вақти дилхоҳатон супоранд, аммо ин кор намекунад. Агар процесс автоматиконида нашавад, вазъият такрор мешавад.
Мо ба YouTrack тағирот ворид кардем. Вазифаи навиштани мақола дар бораи як хусусияти нав ба дӯши нависандаи техникӣ дар ҳамон лаҳзае меафтад, ки ин хусусият ба озмоиш оғоз мекунад. Сипас маркетинг дар бораи он меомӯзад, то ба пешбарӣ омода шавад. Огоҳиҳо инчунин ба мессенҷери корпоративии Mattermost меоянд, аз ин рӯ, аз наворҳои таҳиягарон бехабар мондан ғайриимкон аст.
Ҳуҷҷатҳо дархостҳои корбаронро инъикос намекунанд
Мо одат кардаем, ки ин тавр кор кунем: очерк баромад, дар бораи он гап задем. Мо тавсиф кардем, ки чӣ тавр онро фурӯзон, хомӯш кардан ва ислоҳи хуб ворид кардан лозим аст. Аммо чӣ мешавад, агар муштарӣ нармафзори моро тавре истифода кунад, ки мо интизор набудем? Ё хатоҳое дорад, ки мо дар бораи он фикр накардаем?
Барои кафолат додани он, ки ҳуҷҷатҳо то ҳадди имкон пурра бошанд, мо тавсия медиҳем, ки дархостҳои дастгирӣ, саволҳо дар форумҳои мавзӯӣ ва пурсишҳоро дар системаҳои ҷустуҷӯӣ таҳлил кунем. Мавзӯҳои маъмултарин ба нависандагони техникӣ интиқол дода мешаванд, то онҳо мақолаҳои мавҷударо пурра кунанд ё мақолаҳои нав нависанд.
Хуччатхо такмил дода намешаванд
Дарҳол онро комилан иҷро кардан душвор аст, то ҳол хатогиҳо хоҳанд буд. Шумо метавонед ба фикру мулоҳизаҳои муштариён умедвор шавед, аммо аз эҳтимол дур нест, ки онҳо дар бораи ҳар як хатогӣ, нодурустӣ, нофаҳмо ё беасос хабар диҳанд. Илова ба мизоҷон, кормандон ҳуҷҷатҳоро мехонанд, яъне онҳо ҳамон хатогиҳоро мебинанд. Инро истифода бурдан мумкин аст! Шумо танҳо лозим аст, ки шароите фароҳам оред, ки дар он гузориш додани мушкилот осон бошад.
Мо дар портали дохилӣ гурӯҳе дорем, ки дар он кормандон оид ба ҳуҷҷатгузорӣ эродҳо, пешниҳодҳо ва ғояҳо мегузоранд. Оё дастгирӣ ба мақола ниёз дорад, аммо он вуҷуд надорад? Оё озмоишкунанда нодурустиро пай бурд? Оё шарик ба менеҷерони рушд дар бораи хатогиҳо шикоят кардааст? Ҳама дар ин гурӯҳ! Нависандагони техникӣ баъзе чизҳоро фавран ислоҳ мекунанд, баъзе чизҳоро ба YouTrack интиқол медиҳанд ва ба дигарон вақт медиҳанд, ки дар бораи он фикр кунанд. Барои он ки мавзӯъ аз поён наафтад, гоҳ-гоҳ ба шумо мавҷудияти гурӯҳ ва аҳамияти фикру мулоҳизаҳоро хотиррасон мекунем.
Масъалаи 3. Барои дарёфти мақолаи мувофиқ вақти зиёд лозим аст.
Мақолоте, ки намеёбад, беҳтар аз мақолае нест, ки ёфт намешавад. Шиори ҳуҷҷатҳои хуб бояд "Ҷустуҷӯ осон, пайдо кардан осон" бошад. Чӣ тавр ба ин ноил шудан мумкин аст?
Сохторро ташкил кунед ва принсипи интихоби мавзӯъҳоро муайян кунед. Сохтор бояд ба қадри имкон шаффоф бошад, то хонанда фикр накунад, ки «ман ин мақоларо аз куҷо пайдо кунам?». Барои ҷамъбаст, ду равиш вуҷуд дорад: аз интерфейс ва аз вазифаҳо.
- Аз интерфейс. Мундариҷа қисмҳои панелро такрор мекунад. Ин ҳолат дар ҳуҷҷатҳои кӯҳнаи ISPsystem буд.
- Аз вазифахо. Сарлавҳаҳои мақолаҳо ва бахшҳо вазифаҳои истифодабарандагонро инъикос мекунанд; Сарлавҳаҳо қариб ҳамеша феълҳо ва ҷавобҳоро ба саволи "чӣ тавр кардан" доранд. Ҳоло мо ба ин формат мегузарем.
Новобаста аз он ки шумо кадом равишро интихоб мекунед, боварӣ ҳосил кунед, ки мавзӯъ ба он чизе, ки корбарон меҷӯянд, мувофиқ аст ва ба таври мушаххас ба саволи корбар дахл дорад.
Ҷустуҷӯи мутамарказро таъсис диҳед. Дар ҷаҳони идеалӣ, ҷустуҷӯ ҳатто вақте ки шумо бо забон хато мекунед ё хато мекунед, бояд кор кунад. Ҷустуҷӯи мо дар Confluence то ҳол наметавонад моро бо ин шод кунад. Агар шумо маҳсулоти зиёде дошта бошед ва ҳуҷҷатҳо умумӣ бошанд, ҷустуҷӯро ба саҳифае, ки корбар дар он аст, мутобиқ кунед. Дар ҳолати мо, ҷустуҷӯ дар саҳифаи асосӣ барои ҳама маҳсулот кор мекунад ва агар шумо аллакай дар як бахши мушаххас бошед, пас танҳо барои мақолаҳо дар он.
Иловаи мундариҷа ва нонрезаҳо. Ин хуб аст, вақте ки ҳар як саҳифа дорои меню ва нонрезаҳо - роҳи корбар ба саҳифаи ҷорӣ бо қобилияти баргаштан ба дилхоҳ сатҳ. Дар ҳуҷҷатҳои кӯҳнаи ISPsystem, шумо бояд барои ворид шудан ба мундариҷа аз мақола хориҷ мешудед. Ин номувофиқ буд, бинобар ин мо онро дар наваш ислоҳ кардем.
Истинодҳоро дар маҳсулот ҷойгир кунед. Агар одамон такрор ба такрор бо як савол ба дастгирӣ муроҷиат кунанд, маънои онро дорад, ки бо ҳалли он ба интерфейс ишора кунед. Агар шумо маълумот ё фаҳмиш дошта бошед, ки вақте корбар бо мушкилот дучор мешавад, шумо инчунин метавонед онҳоро бо рӯйхати почтаи электронӣ огоҳ кунед. Ба онҳо ғамхорӣ нишон диҳед ва бори гаронро аз дастгирӣ дур кунед.
Дар тарафи рости равзанаи поп-ап истинод ба мақола дар бораи танзими DNSSEC дар бахши идоракунии домени ISPmanager мавҷуд аст.
Дар дохили ҳуҷҷатҳо истинодҳои байнисоҳавӣ насб кунед. Мақолаҳои бо ҳам алоқаманд бояд "пайванд" шаванд. Агар мақолаҳо пайдарпай бошанд, ҳатман дар охири ҳар як матн тирчаҳои пеш ва ақибро илова кунед.
Эҳтимол, шахс аввал ба саволи худ на ба шумо, балки ба системаи ҷустуҷӯӣ ҷавоб меҷӯяд. Ин шармовар аст, агар дар он ҷо бо сабабҳои техникӣ ягон истинод ба ҳуҷҷатҳо мавҷуд набошад. Пас, дар бораи оптимизатсияи системаи ҷустуҷӯӣ ғамхорӣ кунед.
Масъалаи 4. Тартиби кӯҳнашуда ба дарк халал мерасонад
Илова ба матнҳои бад, ҳуҷҷатҳо метавонанд бо тарроҳӣ вайрон карда шаванд. Одамон ба хондани материалхои хуб навишташуда одат кардаанд. Блогҳо, шабакаҳои иҷтимоӣ, васоити ахбори омма - ҳама мундариҷа на танҳо зебо, балки хондан осон ва ба чашм писанд оварда шудаанд. Аз ин рӯ, шумо метавонед ба осонӣ дарди шахсеро, ки матнро мисли скриншоти зер мебинад, дарк кунед.
Дар ин мақола он қадар скриншотҳо ва нуктаҳои муҳим мавҷуданд, ки онҳо кӯмак намекунанд, балки танҳо ба дарк халал мерасонанд (тасвирро клик кардан мумкин аст)
Шумо набояд аз ҳуҷҷатҳо бо як қатор эффектҳо хонед, аммо шумо бояд қоидаҳои асосиро ба назар гиред.
Тарҳ. Паҳнои матни бадан, ҳуруф, андоза, сарлавҳаҳо ва пуркунии матнро муайян кунед. Дизайнерро киро кунед ва ин корро қабул кунед ё худатон иҷро кунед, китоби Артём Горбуновро хонед "Типография ва макет". Он танҳо як намуди тарҳро пешниҳод мекунад, аммо он кофӣ аст.
Ҷудокунӣ. Муайян кунед, ки дар матн ба чӣ таваҷҷӯҳ лозим аст. Одатан, ин роҳ дар интерфейс, тугмаҳо, замимаҳои код, файлҳои конфигуратсия, блокҳои "Лутфан қайд кунед". Муайян кунед, ки тақсимоти ин унсурҳо чӣ гуна хоҳад буд ва онҳоро дар низомнома сабт кунед. Дар хотир доред, ки чӣ қадаре ки ихроҷ камтар бошад, ҳамон қадар беҳтар аст. Вақте ки онҳо зиёданд, матн ғавғо мекунад. Ҳатто нохунакҳо садо эҷод мекунанд, агар онҳо аз ҳад зиёд истифода шаванд.
Суратҳо. Бо даста розӣ шавед, ки дар кадом ҳолатҳо скриншотҳо лозиманд. Бешубҳа лозим нест, ки ҳар як қадамро тасвир кунад. Шумораи зиёди скриншотҳо, аз ҷумла. тугмаҳои ҷудогона, халал дарк, вайрон кардани тарҳбандии. Андоза, инчунин формати равшанӣ ва имзоҳоро дар скриншотҳо муайян кунед ва онҳоро дар низомнома сабт кунед. Дар хотир доред, ки тасвирҳо бояд ҳамеша ба чизҳои навишташуда мувофиқат кунанд ва мувофиқ бошанд. Боз, агар маҳсулот мунтазам нав карда шавад, пайгирӣ кардани ҳама душвор хоҳад буд.
Дарозии матн. Аз мақолаҳои аз ҳад дароз худдорӣ кунед. Онҳоро ба қисмҳо тақсим кунед ва агар ин имконнопазир бошад, мундариҷаро бо истинодҳои лангар ба аввали мақола илова кунед. Роҳи оддии кӯтоҳтар кардани мақола ин пинҳон кардани ҷузъиёти техникӣ барои доираи танги хонандагон дар зери спойлер мебошад.
Форматҳо. Дар мақолаҳои худ якчанд форматҳоро якҷоя кунед: матн, видео ва тасвирҳо. Ин даркро беҳтар мекунад.
Саъй накунед, ки мушкилотро бо тарҳи зебо пӯшонед. Ростқавлона, мо худамон умедвор будем, ки "маҷмӯа" ҳуҷҷатҳои кӯҳнаро наҷот медиҳад - ин натиҷа надод. Матнҳо он қадар садои визуалӣ ва ҷузъиёти нолозимро дар бар мегирифтанд, ки муқаррарот ва тарҳи нав беқувват буданд.
Аксари чизҳои дар боло зикршударо платформае, ки шумо барои ҳуҷҷатгузорӣ истифода мебаред, муайян мекунад. Масалан, мо Confluence дорем. Ман ҳам маҷбур шудам, ки бо ӯ кор кунам. Агар таваҷҷӯҳ дошта бошед, ҳикояи таҳиягари веби моро хонед: .
Аз куҷо оғоз кардан ба беҳбудӣ ва чӣ гуна зинда мондан
Агар ҳуҷҷатҳои шумо мисли ISPsystem васеъ бошад ва шумо намедонед, ки аз куҷо оғоз кунед, аз мушкилоти бузургтарин оғоз кунед. Мизоҷон ҳуҷҷатро намефаҳманд - матнҳоро такмил медиҳанд, муқаррарот таҳия мекунанд, нависандагонро таълим медиҳанд. Ҳуҷҷатҳо кӯҳна шудаанд - дар бораи равандҳои дохилӣ ғамхорӣ кунед. Бо мақолаҳои маъмултарин дар бораи маҳсулоти маъмултарин оғоз кунед: дастгирӣ пурсед, ба таҳлили сайтҳо ва дархостҳо дар системаҳои ҷустуҷӯ нигаред.
Биёед фавран бигӯем - ин осон нахоҳад буд. Ва он ҳам зуд кор кардан гумон аст. Агар шумо танҳо ба кор шурӯъ накунед ва фавран кори дурустро анҷом диҳед. Як чизе, ки мо аниқ медонем, он аст, ки бо мурури замон беҳтар хоҳад шуд. Аммо ин раванд ҳеҷ гоҳ хотима намеёбад :-).
Манбаъ: will.com