ഉപയോക്തൃ ഡോക്യുമെന്റേഷൻ: എന്താണ് അതിനെ മോശമാക്കുന്നത്, അത് എങ്ങനെ പരിഹരിക്കാം

സോഫ്റ്റ്‌വെയർ ഡോക്യുമെന്റേഷൻ ഒരു കൂട്ടം ലേഖനങ്ങൾ മാത്രമാണ്. എന്നാൽ അവർക്ക് പോലും നിങ്ങളെ ഭ്രാന്തനാക്കാൻ കഴിയും. ആദ്യം, ആവശ്യമായ നിർദ്ദേശങ്ങൾക്കായി നിങ്ങൾ വളരെക്കാലം ചെലവഴിക്കുന്നു. അപ്പോൾ നിങ്ങൾ അവ്യക്തമായ വാചകം മനസ്സിലാക്കുന്നു. നിങ്ങൾ എഴുതിയത് പോലെ ചെയ്യുന്നു, പക്ഷേ പ്രശ്നം പരിഹരിക്കപ്പെട്ടില്ല. നിങ്ങൾ മറ്റൊരു ലേഖനം തിരയുന്നു, നിങ്ങൾ പരിഭ്രാന്തരാകുന്നു ... ഒരു മണിക്കൂർ കഴിഞ്ഞ് നിങ്ങൾ എല്ലാം ഉപേക്ഷിച്ച് പോകുന്നു. മോശം ഡോക്യുമെന്റേഷൻ പ്രവർത്തിക്കുന്നത് ഇങ്ങനെയാണ്. എന്താണ് ഇത് ഇതുപോലെയാക്കുന്നത്, എങ്ങനെ ശരിയാക്കാം - കട്ടിനടിയിൽ വായിക്കുക.

ഞങ്ങളുടെ പഴയ രേഖകളിൽ പല പോരായ്മകളും ഉണ്ടായിരുന്നു. മുകളിൽ വിവരിച്ച സാഹചര്യം ഞങ്ങളുടെ ക്ലയന്റുകളെ ബാധിക്കാതിരിക്കാൻ ഞങ്ങൾ ഏകദേശം ഒരു വർഷമായി ഇത് പുനർനിർമ്മിക്കുന്നു. നോക്കൂ, അത് പോലെ и ഇത് എങ്ങനെ സംഭവിച്ചു.

പ്രശ്നം 1: വ്യക്തമല്ലാത്ത, മോശമായി എഴുതിയ ലേഖനങ്ങൾ

ഡോക്യുമെന്റേഷൻ മനസ്സിലാക്കാൻ കഴിയുന്നില്ലെങ്കിൽ, അതിന്റെ അർത്ഥമെന്താണ്? പക്ഷേ ആരും മനഃപൂർവം മനസ്സിലാക്കാൻ പറ്റാത്ത ലേഖനങ്ങൾ എഴുതാറില്ല. രചയിതാവ് പ്രേക്ഷകരെയും ഉദ്ദേശ്യത്തെയും കുറിച്ച് ചിന്തിക്കാതിരിക്കുകയും വെള്ളം ഒഴിക്കുകയും പിശകുകൾക്കായി വാചകം പരിശോധിക്കാതിരിക്കുകയും ചെയ്യുമ്പോൾ അവ സംഭവിക്കുന്നു.

• പ്രേക്ഷകർ. ഒരു ലേഖനം എഴുതുന്നതിനുമുമ്പ്, വായനക്കാരന്റെ തയ്യാറെടുപ്പിന്റെ നിലവാരത്തെക്കുറിച്ച് നിങ്ങൾ ചിന്തിക്കേണ്ടതുണ്ട്. തുടക്കക്കാർക്കുള്ള ഒരു ലേഖനത്തിൽ നിങ്ങൾ അടിസ്ഥാന ഘട്ടങ്ങൾ ഒഴിവാക്കുകയും സാങ്കേതിക പദങ്ങൾ വിശദീകരണമില്ലാതെ ഉപേക്ഷിക്കുകയും ചെയ്യരുത് എന്നത് യുക്തിസഹമാണ്, എന്നാൽ പ്രൊഫഷണലുകൾക്ക് മാത്രം ആവശ്യമുള്ള ഒരു അപൂർവ സവിശേഷതയെക്കുറിച്ചുള്ള ഒരു ലേഖനത്തിൽ, PHP എന്ന വാക്കിന്റെ അർത്ഥം നിങ്ങൾ വിശദീകരിക്കണം.
• ലക്ഷ്യം. ഒരു കാര്യം കൂടി മുൻകൂട്ടി ആലോചിക്കണം. രചയിതാവ് വ്യക്തമായ ഒരു ലക്ഷ്യം സജ്ജീകരിക്കുകയും ലേഖനത്തിന്റെ ഉപയോഗപ്രദമായ പ്രഭാവം നിർണ്ണയിക്കുകയും അത് വായിച്ചതിനുശേഷം വായനക്കാരൻ എന്തുചെയ്യണമെന്ന് തീരുമാനിക്കുകയും വേണം. ഇത് ചെയ്തില്ലെങ്കിൽ, വിവരണത്തിനായി നിങ്ങൾ വിവരണത്തിൽ അവസാനിക്കും.
• വെള്ളവും ബഗുകളും. അനാവശ്യമായ ധാരാളം വിവരങ്ങളും ബ്യൂറോക്രസിയും പിശകുകളും അക്ഷരത്തെറ്റുകളും ധാരണയെ തടസ്സപ്പെടുത്തുന്നു. വായനക്കാരൻ ഒരു വ്യാകരണ നാസി അല്ലെങ്കിലും, വാചകത്തിലെ അശ്രദ്ധ അവനെ ഓഫ് ചെയ്യും.

മുകളിലുള്ള നുറുങ്ങുകൾ പരിഗണിക്കുക, ലേഖനങ്ങൾ കൂടുതൽ വ്യക്തമാകും - ഉറപ്പ്. ഇത് കൂടുതൽ മികച്ചതാക്കാൻ, ഞങ്ങളുടെ ഉപയോഗിക്കുക സാങ്കേതിക ഡോക്യുമെന്റേഷനിൽ പ്രവർത്തിക്കുമ്പോൾ 50 ചോദ്യങ്ങൾ.

പ്രശ്നം 2. ലേഖനങ്ങൾ എല്ലാ ചോദ്യങ്ങൾക്കും ഉത്തരം നൽകുന്നില്ല

ഡോക്യുമെന്റേഷൻ വികസനവുമായി പൊരുത്തപ്പെടുന്നില്ലെങ്കിൽ, യഥാർത്ഥ ചോദ്യങ്ങൾക്ക് ഉത്തരം നൽകുന്നില്ല, അതിൽ തെറ്റുകൾ വർഷങ്ങളോളം തിരുത്തപ്പെടാത്തപ്പോൾ അത് മോശമാണ്. ഇവ രചയിതാവിന്റെ പ്രശ്‌നങ്ങളല്ല, കമ്പനിക്കുള്ളിലെ പ്രക്രിയകളുടെ ഓർഗനൈസേഷന്റെ പ്രശ്‌നങ്ങളാണ്.

ഡോക്യുമെന്റേഷൻ വികസനവുമായി പൊരുത്തപ്പെടുന്നില്ല

ഫീച്ചർ ഇതിനകം തന്നെ റിലീസിലാണ്, അത് മറയ്ക്കാൻ മാർക്കറ്റിംഗ് പ്ലാൻ ചെയ്യുന്നു, തുടർന്ന് പുതിയ ലേഖനമോ വിവർത്തനമോ ഇപ്പോഴും ഡോക്യുമെന്റേഷനിൽ ഇല്ലെന്ന് മാറുന്നു. ഇക്കാരണത്താൽ ഞങ്ങൾക്ക് റിലീസ് മാറ്റിവയ്ക്കേണ്ടി വന്നു. നിങ്ങൾക്ക് ആവശ്യമുള്ളത്ര കൃത്യസമയത്ത് സാങ്കേതിക എഴുത്തുകാർക്ക് ചുമതലകൾ കൈമാറാൻ എല്ലാവരോടും ആവശ്യപ്പെടാം, പക്ഷേ അത് പ്രവർത്തിക്കില്ല. പ്രക്രിയ യാന്ത്രികമല്ലെങ്കിൽ, സാഹചര്യം ആവർത്തിക്കും.

YouTrack-ൽ ഞങ്ങൾ മാറ്റങ്ങൾ വരുത്തിയിട്ടുണ്ട്. ഫീച്ചർ പരീക്ഷിക്കാൻ തുടങ്ങുന്ന അതേ നിമിഷത്തിൽ തന്നെ ഒരു പുതിയ സവിശേഷതയെക്കുറിച്ച് ഒരു ലേഖനം എഴുതാനുള്ള ചുമതല സാങ്കേതിക എഴുത്തുകാരന്റെ പക്കൽ വരുന്നു. തുടർന്ന് പ്രമോഷനായി തയ്യാറെടുക്കുന്നതിനായി മാർക്കറ്റിംഗ് അതിനെക്കുറിച്ച് പഠിക്കുന്നു. മാറ്റർമോസ്റ്റ് കോർപ്പറേറ്റ് മെസഞ്ചറിലേക്കും അറിയിപ്പുകൾ വരുന്നു, അതിനാൽ ഡെവലപ്പർമാരിൽ നിന്നുള്ള വാർത്തകൾ നഷ്‌ടപ്പെടുത്തുന്നത് അസാധ്യമാണ്.

ഡോക്യുമെന്റേഷൻ ഉപയോക്തൃ അഭ്യർത്ഥനകളെ പ്രതിഫലിപ്പിക്കുന്നില്ല

ഞങ്ങൾ ഇതുപോലെ പ്രവർത്തിക്കുന്നത് പതിവാണ്: ഒരു സവിശേഷത പുറത്തുവന്നു, ഞങ്ങൾ അതിനെക്കുറിച്ച് സംസാരിച്ചു. ഇത് എങ്ങനെ ഓണാക്കാമെന്നും ഓഫാക്കാമെന്നും മികച്ച ക്രമീകരണങ്ങൾ വരുത്താമെന്നും ഞങ്ങൾ വിവരിച്ചു. എന്നാൽ നമ്മൾ പ്രതീക്ഷിക്കാത്ത രീതിയിൽ ഒരു ക്ലയന്റ് നമ്മുടെ സോഫ്റ്റ്‌വെയർ ഉപയോഗിച്ചാലോ? അതോ നമ്മൾ ചിന്തിക്കാത്ത തെറ്റുകളുണ്ടോ?

ഡോക്യുമെന്റേഷൻ കഴിയുന്നത്ര പൂർണ്ണമാണെന്ന് ഉറപ്പാക്കാൻ, പിന്തുണ അഭ്യർത്ഥനകൾ, തീമാറ്റിക് ഫോറങ്ങളിലെ ചോദ്യങ്ങൾ, തിരയൽ എഞ്ചിനുകളിലെ ചോദ്യങ്ങൾ എന്നിവ വിശകലനം ചെയ്യാൻ ഞങ്ങൾ ശുപാർശ ചെയ്യുന്നു. ഏറ്റവും പ്രചാരമുള്ള വിഷയങ്ങൾ സാങ്കേതിക രചയിതാക്കൾക്ക് കൈമാറും, അതിലൂടെ അവർക്ക് നിലവിലുള്ള ലേഖനങ്ങൾ കൂട്ടിച്ചേർക്കാനോ പുതിയവ എഴുതാനോ കഴിയും.

ഡോക്യുമെന്റേഷൻ മെച്ചപ്പെടുത്തുന്നില്ല

ഇത് ഉടനടി പൂർണ്ണമായും ചെയ്യാൻ പ്രയാസമാണ്; ഇനിയും തെറ്റുകൾ ഉണ്ടാകും. ഉപഭോക്താക്കളിൽ നിന്ന് നിങ്ങൾക്ക് ഫീഡ്‌ബാക്ക് പ്രതീക്ഷിക്കാം, എന്നാൽ എല്ലാ അക്ഷരപ്പിശകുകളും കൃത്യതയില്ലായ്മയും മനസ്സിലാക്കാൻ കഴിയാത്തതോ അടിസ്ഥാനരഹിതമായതോ ആയ ലേഖനം അവർ റിപ്പോർട്ട് ചെയ്യാൻ സാധ്യതയില്ല. ക്ലയന്റുകൾക്ക് പുറമേ, ജീവനക്കാർ ഡോക്യുമെന്റേഷൻ വായിക്കുന്നു, അതായത് അതേ പിശകുകൾ അവർ കാണുന്നു. ഇത് ഉപയോഗിക്കാം! ഒരു പ്രശ്‌നം റിപ്പോർട്ടുചെയ്യാൻ എളുപ്പമുള്ള സാഹചര്യങ്ങൾ നിങ്ങൾ സൃഷ്‌ടിക്കേണ്ടതുണ്ട്.

ഡോക്യുമെന്റേഷനിൽ ജീവനക്കാർ അഭിപ്രായങ്ങളും നിർദ്ദേശങ്ങളും ആശയങ്ങളും നൽകുന്ന ആന്തരിക പോർട്ടലിൽ ഞങ്ങൾക്ക് ഒരു ഗ്രൂപ്പ് ഉണ്ട്. പിന്തുണയ്‌ക്ക് ഒരു ലേഖനം ആവശ്യമുണ്ടോ, പക്ഷേ അത് നിലവിലില്ലേ? ടെസ്റ്റർ കൃത്യതയില്ലായ്മ ശ്രദ്ധിച്ചോ? പിശകുകളെക്കുറിച്ച് പങ്കാളി വികസന മാനേജർമാരോട് പരാതിപ്പെട്ടിട്ടുണ്ടോ? ഈ ഗ്രൂപ്പിലെ എല്ലാവരും! സാങ്കേതിക രചയിതാക്കൾ ചില കാര്യങ്ങൾ ഉടനടി ശരിയാക്കുകയും ചില കാര്യങ്ങൾ YouTrack-ലേക്ക് മാറ്റുകയും മറ്റുള്ളവർക്ക് ചിന്തിക്കാൻ കുറച്ച് സമയം നൽകുകയും ചെയ്യുന്നു. വിഷയം മരിക്കുന്നത് തടയാൻ, ഇടയ്ക്കിടെ ഞങ്ങൾ ഗ്രൂപ്പിന്റെ നിലനിൽപ്പിനെയും ഫീഡ്‌ബാക്കിന്റെ പ്രാധാന്യത്തെയും കുറിച്ച് നിങ്ങളെ ഓർമ്മിപ്പിക്കുന്നു.

പ്രശ്നം 3. ശരിയായ ലേഖനം കണ്ടെത്തുന്നതിന് വളരെ സമയമെടുക്കും.

കണ്ടെത്താൻ കഴിയാത്ത ഒരു ലേഖനം കണ്ടെത്താൻ കഴിയാത്ത ലേഖനത്തേക്കാൾ മികച്ചതല്ല. നല്ല ഡോക്യുമെന്റേഷന്റെ മുദ്രാവാക്യം "തിരയാൻ എളുപ്പമാണ്, കണ്ടെത്താൻ എളുപ്പമാണ്" എന്നതായിരിക്കണം. ഇത് എങ്ങനെ നേടാം?

ഘടന സംഘടിപ്പിക്കുകയും വിഷയങ്ങൾ തിരഞ്ഞെടുക്കുന്നതിനുള്ള തത്വം നിർണ്ണയിക്കുകയും ചെയ്യുക. "എനിക്ക് ഈ ലേഖനം എവിടെ കണ്ടെത്താനാകും?" എന്ന് വായനക്കാരൻ ചിന്തിക്കാതിരിക്കാൻ ഘടന കഴിയുന്നത്ര സുതാര്യമായിരിക്കണം. ചുരുക്കത്തിൽ, രണ്ട് സമീപനങ്ങളുണ്ട്: ഇന്റർഫേസിൽ നിന്നും ടാസ്ക്കുകളിൽ നിന്നും.

1. ഇന്റർഫേസിൽ നിന്ന്. ഉള്ളടക്കം പാനൽ വിഭാഗങ്ങളെ ഡ്യൂപ്ലിക്കേറ്റ് ചെയ്യുന്നു. പഴയ ISPസിസ്റ്റം ഡോക്യുമെന്റേഷനിൽ ഇതുതന്നെയായിരുന്നു സ്ഥിതി.
2. ചുമതലകളിൽ നിന്ന്. ലേഖനങ്ങളുടെയും വിഭാഗങ്ങളുടെയും ശീർഷകങ്ങൾ ഉപയോക്താക്കളുടെ ചുമതലകളെ പ്രതിഫലിപ്പിക്കുന്നു; ശീർഷകങ്ങളിൽ മിക്കവാറും എല്ലായ്‌പ്പോഴും ക്രിയകളും "എങ്ങനെ" എന്ന ചോദ്യത്തിനുള്ള ഉത്തരങ്ങളും അടങ്ങിയിരിക്കുന്നു. ഇപ്പോൾ ഞങ്ങൾ ഈ ഫോർമാറ്റിലേക്ക് നീങ്ങുകയാണ്.

നിങ്ങൾ തിരഞ്ഞെടുക്കുന്ന സമീപനം എന്തുതന്നെയായാലും, ഉപയോക്താക്കൾ തിരയുന്ന വിഷയത്തിന് വിഷയം പ്രസക്തമാണെന്നും ഉപയോക്താവിന്റെ ചോദ്യത്തെ പ്രത്യേകമായി അഭിസംബോധന ചെയ്യുന്ന വിധത്തിൽ ഉൾപ്പെടുത്തിയിട്ടുണ്ടെന്നും ഉറപ്പാക്കുക.

ഒരു കേന്ദ്രീകൃത തിരയൽ സജ്ജമാക്കുക. അനുയോജ്യമായ ഒരു ലോകത്ത്, നിങ്ങൾ അക്ഷരത്തെറ്റ് തെറ്റിയാലും ഭാഷയിൽ തെറ്റ് വരുത്തിയാലും തിരയൽ പ്രവർത്തിക്കണം. ഇതുവരെയുള്ള സംഗമത്തിൽ ഞങ്ങൾ നടത്തിയ തിരച്ചിലിൽ ഞങ്ങളെ തൃപ്തിപ്പെടുത്താൻ കഴിയില്ല. നിങ്ങൾക്ക് നിരവധി ഉൽപ്പന്നങ്ങൾ ഉണ്ടെങ്കിൽ, ഡോക്യുമെന്റേഷൻ പൊതുവായതാണെങ്കിൽ, ഉപയോക്താവ് ഉള്ള പേജിലേക്ക് തിരച്ചിൽ ക്രമീകരിക്കുക. ഞങ്ങളുടെ കാര്യത്തിൽ, പ്രധാന പേജിലെ തിരയൽ എല്ലാ ഉൽപ്പന്നങ്ങൾക്കും പ്രവർത്തിക്കുന്നു, നിങ്ങൾ ഇതിനകം ഒരു പ്രത്യേക വിഭാഗത്തിലാണെങ്കിൽ, അതിലെ ലേഖനങ്ങൾക്കായി മാത്രം.

ഉള്ളടക്കവും ബ്രെഡ്ക്രംബ്സും ചേർക്കുക. ഓരോ പേജിനും ഒരു മെനുവും ബ്രെഡ്ക്രംബുകളും ഉള്ളപ്പോൾ ഇത് നല്ലതാണ് - ഏത് തലത്തിലേക്കും മടങ്ങാനുള്ള കഴിവുള്ള നിലവിലെ പേജിലേക്കുള്ള ഉപയോക്താവിന്റെ പാത. പഴയ ISPസിസ്റ്റം ഡോക്യുമെന്റേഷനിൽ, ഉള്ളടക്കത്തിലേക്ക് എത്താൻ നിങ്ങൾ ലേഖനത്തിൽ നിന്ന് പുറത്തുകടക്കേണ്ടതുണ്ട്. ഇത് അസൗകര്യമായതിനാൽ ഞങ്ങൾ അത് പുതിയതിൽ പരിഹരിച്ചു.

ഉൽപ്പന്നത്തിൽ ലിങ്കുകൾ സ്ഥാപിക്കുക. ഒരേ ചോദ്യവുമായി ആളുകൾ വീണ്ടും വീണ്ടും പിന്തുണയ്‌ക്കുകയാണെങ്കിൽ, ഇന്റർഫേസിലേക്ക് അതിന്റെ പരിഹാരത്തിനൊപ്പം ഒരു സൂചന ചേർക്കുന്നത് അർത്ഥമാക്കുന്നു. ഒരു ഉപയോക്താവിന് ഒരു പ്രശ്‌നം അനുഭവപ്പെടുമ്പോൾ നിങ്ങൾക്ക് ഡാറ്റയോ ഉൾക്കാഴ്ചയോ ഉണ്ടെങ്കിൽ, നിങ്ങൾക്ക് ഒരു മെയിലിംഗ് ലിസ്റ്റ് ഉപയോഗിച്ച് അവരെ അറിയിക്കാനും കഴിയും. അവരോട് ഉത്കണ്ഠ കാണിക്കുകയും പിന്തുണയിൽ നിന്ന് ഭാരം ഒഴിവാക്കുകയും ചെയ്യുക.

പോപ്പ്-അപ്പ് വിൻഡോയിൽ വലതുവശത്ത് ISPmanager-ന്റെ ഡൊമെയ്ൻ മാനേജ്മെന്റ് വിഭാഗത്തിൽ DNSSEC സജ്ജീകരിക്കുന്നതിനെക്കുറിച്ചുള്ള ഒരു ലേഖനത്തിലേക്കുള്ള ഒരു ലിങ്ക് ഉണ്ട്.

ഡോക്യുമെന്റേഷനിൽ ക്രോസ്-റഫറൻസുകൾ സജ്ജമാക്കുക. പരസ്പരം ബന്ധപ്പെട്ടിരിക്കുന്ന ലേഖനങ്ങൾ "ലിങ്ക്" ചെയ്യണം. ലേഖനങ്ങൾ ക്രമാനുഗതമാണെങ്കിൽ, ഓരോ വാചകത്തിന്റെയും അവസാനം മുന്നോട്ടും പിന്നോട്ടും അമ്പടയാളങ്ങൾ ചേർക്കുന്നത് ഉറപ്പാക്കുക.

മിക്കവാറും, ഒരു വ്യക്തി ആദ്യം തന്റെ ചോദ്യത്തിനുള്ള ഉത്തരം തേടുന്നത് നിങ്ങളോടല്ല, മറിച്ച് ഒരു തിരയൽ എഞ്ചിനിലേക്കാണ്. സാങ്കേതിക കാരണങ്ങളാൽ ഡോക്യുമെന്റേഷനിലേക്ക് ലിങ്കുകളൊന്നും ഇല്ലെങ്കിൽ അത് ലജ്ജാകരമാണ്. അതിനാൽ സെർച്ച് എഞ്ചിൻ ഒപ്റ്റിമൈസേഷൻ ശ്രദ്ധിക്കുക.

പ്രശ്നം 4. കാലഹരണപ്പെട്ട ലേഔട്ട് ധാരണയെ തടസ്സപ്പെടുത്തുന്നു

മോശം ടെക്സ്റ്റുകൾക്ക് പുറമേ, ഡോക്യുമെന്റേഷൻ ഡിസൈൻ വഴി നശിപ്പിക്കാൻ കഴിയും. ആളുകൾ നന്നായി എഴുതിയ മെറ്റീരിയലുകൾ വായിക്കാൻ ശീലിച്ചിരിക്കുന്നു. ബ്ലോഗുകൾ, സോഷ്യൽ നെറ്റ്‌വർക്കുകൾ, മീഡിയ - എല്ലാ ഉള്ളടക്കവും മനോഹരമായി മാത്രമല്ല, വായിക്കാൻ എളുപ്പവും കണ്ണിന് ഇമ്പമുള്ളതും അവതരിപ്പിക്കുന്നു. അതിനാൽ, ചുവടെയുള്ള സ്ക്രീൻഷോട്ടിലെ പോലെ ടെക്സ്റ്റ് കാണുന്ന ഒരു വ്യക്തിയുടെ വേദന നിങ്ങൾക്ക് എളുപ്പത്തിൽ മനസ്സിലാക്കാൻ കഴിയും.

ഈ ലേഖനത്തിൽ നിരവധി സ്‌ക്രീൻഷോട്ടുകളും ഹൈലൈറ്റുകളും ഉണ്ട്, അവ സഹായിക്കില്ല, പക്ഷേ അവ ധാരണയെ തടസ്സപ്പെടുത്തുന്നു (ചിത്രം ക്ലിക്കുചെയ്യാനാകും)

ഒരു കൂട്ടം ഇഫക്റ്റുകൾ ഉപയോഗിച്ച് നിങ്ങൾ ഡോക്യുമെന്റേഷനിൽ നിന്ന് ദീർഘനേരം വായിക്കരുത്, പക്ഷേ നിങ്ങൾ അടിസ്ഥാന നിയമങ്ങൾ കണക്കിലെടുക്കേണ്ടതുണ്ട്.

ലേഔട്ട്. ബോഡി ടെക്സ്റ്റ് വീതി, ഫോണ്ട്, വലിപ്പം, തലക്കെട്ടുകൾ, പാഡിംഗ് എന്നിവ നിർണ്ണയിക്കുക. ഒരു ഡിസൈനറെ വാടകയ്‌ക്കെടുക്കുക, ജോലി സ്വീകരിക്കുന്നതിനോ സ്വയം ചെയ്യാൻ ആഗ്രഹിക്കുന്നതിനോ, ആർട്ടിയോം ഗോർബുനോവിന്റെ "ടൈപ്പോഗ്രഫിയും ലേഔട്ടും" എന്ന പുസ്തകം വായിക്കുക. ഇത് ലേഔട്ടിന്റെ ഒരു കാഴ്ച മാത്രമേ അവതരിപ്പിക്കുന്നുള്ളൂ, പക്ഷേ ഇത് മതിയാകും.

വിഹിതം. വാചകത്തിൽ എന്താണ് ഊന്നൽ നൽകേണ്ടതെന്ന് നിർണ്ണയിക്കുക. സാധാരണയായി ഇത് ഇന്റർഫേസ്, ബട്ടണുകൾ, കോഡ് ഉൾപ്പെടുത്തലുകൾ, കോൺഫിഗറേഷൻ ഫയലുകൾ, "ദയവായി ശ്രദ്ധിക്കുക" ബ്ലോക്കുകളിലെ ഒരു പാതയാണ്. ഈ മൂലകങ്ങളുടെ അലോക്കേഷനുകൾ എന്തായിരിക്കുമെന്ന് നിർണ്ണയിക്കുകയും അവ നിയന്ത്രണങ്ങളിൽ രേഖപ്പെടുത്തുകയും ചെയ്യുക. ഡിസ്ചാർജ് കുറയുന്നത് മികച്ചതാണെന്ന് ഓർമ്മിക്കുക. അവയിൽ ധാരാളം ഉള്ളപ്പോൾ, വാചകം ശബ്ദമയമാണ്. പലപ്പോഴും ഉപയോഗിച്ചാൽ ഉദ്ധരണി ചിഹ്നങ്ങൾ പോലും ശബ്ദമുണ്ടാക്കുന്നു.

സ്ക്രീൻഷോട്ടുകൾ. ഏത് സാഹചര്യത്തിലാണ് സ്ക്രീൻഷോട്ടുകൾ ആവശ്യമുള്ളതെന്ന് ടീമുമായി യോജിക്കുക. തീർച്ചയായും ഓരോ ഘട്ടവും ചിത്രീകരിക്കേണ്ട ആവശ്യമില്ല. ധാരാളം സ്ക്രീൻഷോട്ടുകൾ, ഉൾപ്പെടെ. പ്രത്യേക ബട്ടണുകൾ, ധാരണയിൽ ഇടപെടുക, ലേഔട്ട് നശിപ്പിക്കുക. വലുപ്പവും സ്‌ക്രീൻഷോട്ടുകളിലെ ഹൈലൈറ്റുകളുടെയും ഒപ്പുകളുടെയും ഫോർമാറ്റും നിർണ്ണയിക്കുക, അവ നിയന്ത്രണങ്ങളിൽ രേഖപ്പെടുത്തുക. ചിത്രീകരണങ്ങൾ എല്ലായ്‌പ്പോഴും എഴുതിയവയുമായി പൊരുത്തപ്പെടേണ്ടതും പ്രസക്തവുമായിരിക്കണമെന്ന് ഓർമ്മിക്കുക. വീണ്ടും, ഉൽപ്പന്നം പതിവായി അപ്‌ഡേറ്റ് ചെയ്യുകയാണെങ്കിൽ, എല്ലാവരുടെയും ട്രാക്ക് സൂക്ഷിക്കുന്നത് ബുദ്ധിമുട്ടായിരിക്കും.

വാചക ദൈർഘ്യം. ദൈർഘ്യമേറിയ ലേഖനങ്ങൾ ഒഴിവാക്കുക. അവയെ ഭാഗങ്ങളായി വിഭജിക്കുക, ഇത് സാധ്യമല്ലെങ്കിൽ, ലേഖനത്തിന്റെ തുടക്കത്തിലേക്ക് ആങ്കർ ലിങ്കുകളുള്ള ഉള്ളടക്കം ചേർക്കുക. ഒരു ലേഖനം ദൃശ്യപരമായി ചെറുതാക്കാനുള്ള ഒരു ലളിതമായ മാർഗ്ഗം, വായനക്കാരുടെ ഇടുങ്ങിയ സർക്കിളിന് ആവശ്യമായ സാങ്കേതിക വിശദാംശങ്ങൾ ഒരു സ്‌പോയിലറിന് കീഴിൽ മറയ്ക്കുക എന്നതാണ്.

ഫോർമാറ്റുകൾ. നിങ്ങളുടെ ലേഖനങ്ങളിൽ നിരവധി ഫോർമാറ്റുകൾ സംയോജിപ്പിക്കുക: ടെക്സ്റ്റ്, വീഡിയോ, ഇമേജുകൾ. ഇത് ധാരണ മെച്ചപ്പെടുത്തും.

മനോഹരമായ ലേഔട്ട് ഉപയോഗിച്ച് പ്രശ്നങ്ങൾ മറയ്ക്കാൻ ശ്രമിക്കരുത്. സത്യസന്ധമായി, "റാപ്പർ" കാലഹരണപ്പെട്ട ഡോക്യുമെന്റേഷൻ സംരക്ഷിക്കുമെന്ന് ഞങ്ങൾ തന്നെ പ്രതീക്ഷിച്ചു - അത് പ്രവർത്തിച്ചില്ല. ഗ്രന്ഥങ്ങളിൽ വളരെയധികം ദൃശ്യശബ്ദവും അനാവശ്യ വിശദാംശങ്ങളും അടങ്ങിയിരിക്കുന്നതിനാൽ നിയന്ത്രണങ്ങളും പുതിയ രൂപകൽപ്പനയും ശക്തിയില്ലാത്തതായിരുന്നു.

മുകളിൽ പറഞ്ഞവയിൽ ഭൂരിഭാഗവും ഡോക്യുമെന്റേഷനായി നിങ്ങൾ ഉപയോഗിക്കുന്ന പ്ലാറ്റ്ഫോം നിർണ്ണയിക്കും. ഉദാഹരണത്തിന്, നമുക്ക് Confluence ഉണ്ട്. എനിക്കും അവനുമായി ടിങ്കർ ചെയ്യേണ്ടി വന്നു. താൽപ്പര്യമുണ്ടെങ്കിൽ, ഞങ്ങളുടെ വെബ് ഡെവലപ്പറുടെ കഥ വായിക്കുക: ഒരു പൊതു വിജ്ഞാന അടിത്തറയ്ക്കുള്ള സംഗമം: രൂപകല്പന മാറ്റുകയും ഭാഷകൾക്കനുസരിച്ച് വേർതിരിക്കുകയും ചെയ്യുക.

മെച്ചപ്പെടാൻ എവിടെ തുടങ്ങണം, എങ്ങനെ അതിജീവിക്കും

നിങ്ങളുടെ ഡോക്യുമെന്റേഷൻ ISP സിസ്‌റ്റം പോലെ വിശാലമാണെങ്കിൽ എവിടെ തുടങ്ങണമെന്ന് നിങ്ങൾക്കറിയില്ലെങ്കിൽ, ഏറ്റവും വലിയ പ്രശ്‌നങ്ങളിൽ നിന്ന് ആരംഭിക്കുക. ഉപഭോക്താക്കൾക്ക് പ്രമാണം മനസ്സിലാകുന്നില്ല - പാഠങ്ങൾ മെച്ചപ്പെടുത്തുക, നിയന്ത്രണങ്ങൾ ഉണ്ടാക്കുക, എഴുത്തുകാരെ പരിശീലിപ്പിക്കുക. ഡോക്യുമെന്റേഷൻ കാലഹരണപ്പെട്ടതാണ് - ആന്തരിക പ്രക്രിയകൾ ശ്രദ്ധിക്കുക. ഏറ്റവും ജനപ്രിയമായ ഉൽപ്പന്നങ്ങളെക്കുറിച്ചുള്ള ഏറ്റവും ജനപ്രിയമായ ലേഖനങ്ങളിൽ നിന്ന് ആരംഭിക്കുക: പിന്തുണ ചോദിക്കുക, സൈറ്റ് അനലിറ്റിക്‌സും തിരയൽ എഞ്ചിനുകളിലെ അന്വേഷണങ്ങളും നോക്കുക.

നമുക്ക് ഉടൻ തന്നെ പറയാം - അത് എളുപ്പമായിരിക്കില്ല. മാത്രമല്ല അത് വേഗത്തിൽ പ്രവർത്തിക്കാൻ സാധ്യതയില്ല. നിങ്ങൾ ആരംഭിക്കുകയും ശരിയായ കാര്യം ഉടൻ ചെയ്യുകയുമല്ലാതെ. കാലക്രമേണ അത് മെച്ചപ്പെടും എന്നതാണ് നമുക്ക് ഉറപ്പായും അറിയാവുന്ന ഒരു കാര്യം. എന്നാൽ പ്രക്രിയ ഒരിക്കലും അവസാനിക്കില്ല :-).

അവലംബം: www.habr.com