පරිශීලක ලියකියවිලි: එය නරක වන්නේ කුමක්ද සහ එය නිවැරදි කරන්නේ කෙසේද

මෘදුකාංග ලේඛන යනු ලිපි මාලාවක් පමණි. නමුත් ඔවුන්ට පවා ඔබව පිස්සු වට්ටන්න පුළුවන්. පළමුව, ඔබ අවශ්ය උපදෙස් සඳහා දිගු කාලයක් ගත කරයි. එවිට ඔබට අපැහැදිලි පාඨය වැටහේ. ඔබ ලියා ඇති පරිදි කරන්න, නමුත් ගැටලුව විසඳී නැත. ඔබ වෙනත් ලිපියක් සොයනවා, ඔබ කලබල වෙනවා ... පැයකට පසු ඔබ සියල්ල අතහැර දමා යන්න. නරක ලියකියවිලි ක්‍රියා කරන ආකාරය මෙයයි. එය මේ වගේ කරන්නේ කුමක්ද සහ එය නිවැරදි කරන්නේ කෙසේද - කප්පාදුව යටතේ කියවන්න.

අපේ පැරණි ලියකියවිලිවල බොහෝ අඩුපාඩු තිබුණා. ඉහත විස්තර කර ඇති තත්වය අපගේ ගනුදෙනුකරුවන්ට බල නොපාන ලෙස අපි දැන් වසරකට ආසන්න කාලයක් එය නැවත සකස් කරමින් සිටිමු. බලන්න, එය සිදුවූ ලෙසින් ම и එය සිදුවූයේ කොහොමද.

ගැටලුව 1: නොපැහැදිලි, දුර්වල ලෙස ලියා ඇති ලිපි

ලේඛන තේරුම් ගැනීමට නොහැකි නම්, එහි තේරුම කුමක්ද? ඒත් කවුරුත් හිතාමතාම නොතේරෙන ලිපි ලියන්නේ නැහැ. ඒවා සිදුවන්නේ කතුවරයා ප්‍රේක්ෂකයින් සහ අරමුණ ගැන නොසිතන විට, ජලය වත් කරන විට සහ වැරදි සඳහා පෙළ පරීක්ෂා නොකරන විටය.

• ප්‍රේක්ෂකයෝ. ලිපියක් ලිවීමට පෙර, ඔබ පාඨකයාගේ සූදානම් වීමේ මට්ටම ගැන සිතා බැලිය යුතුය. ආරම්භකයකු සඳහා වන ලිපියක ඔබ මූලික පියවරයන් මඟ හැර තාක්ෂණික යෙදුම් පැහැදිලි කිරීමකින් තොරව නොතැබිය යුතු බව තර්කානුකූල ය, නමුත් වෘත්තිකයන්ට පමණක් අවශ්‍ය වන දුර්ලභ විශේෂාංගයක් පිළිබඳ ලිපියක, ඔබ PHP යන වචනයේ තේරුම පැහැදිලි කළ යුතුය.
• ඉලක්කය. තවත් දෙයක් කල්තියා සිතා බැලිය යුතුය. කතුවරයා පැහැදිලි ඉලක්කයක් තැබිය යුතුය, ලිපියේ ප්රයෝජනවත් බලපෑම තීරණය කළ යුතුය, එය කියවීමෙන් පසු පාඨකයා කුමක් කරන්නේද යන්න තීරණය කළ යුතුය. මෙය සිදු නොකළහොත්, ඔබ විස්තරය සඳහා විස්තරය සමඟ අවසන් වනු ඇත.
• ජලය සහ දෝෂ. අනවශ්‍ය තොරතුරු රාශියක් ඇති අතර නිලධාරිවාදය, දෝෂ සහ අක්ෂර වින්‍යාසය සංජානනයට බාධා කරයි. පාඨකයා ව්‍යාකරණ නාසියෙක් නොවුනත්, පාඨයේ නොසැලකිලිමත්කම නිසා ඔහුව නිවා දැමිය හැක.

ඉහත ඉඟි සලකා බලන්න, එවිට ලිපි වඩාත් පැහැදිලි වනු ඇත - සහතිකයි. එය වඩාත් හොඳ කිරීමට, අපගේ භාවිතා කරන්න තාක්ෂණික ලියකියවිලි මත වැඩ කරන විට ප්රශ්න 50 ක්.

ගැටලුව 2. ලිපි සියලු ප්රශ්නවලට පිළිතුරු සපයන්නේ නැත

ලේඛනගත කිරීම සංවර්ධනය සමඟ නොනවත්වා, සැබෑ ප්රශ්නවලට පිළිතුරු නොදෙන විට, වසර ගණනාවක් තිස්සේ එහි දෝෂ නිවැරදි කර නොමැති විට එය නරක ය. මේවා කතුවරයාගේ ගැටළු නොව, සමාගම තුළ ක්‍රියාවලි සංවිධානය කිරීමේ ගැටළු වේ.

ප්‍රලේඛනය සංවර්ධනය සමඟ නොගැලපේ

විශේෂාංගය දැනටමත් නිකුත් කර ඇත, එය ආවරණය කිරීමට අලෙවිකරණය සැලසුම් කරයි, පසුව නව ලිපිය හෝ පරිවර්තනය තවමත් ලේඛනගත කර නොමැති බව පෙනී යයි. මේ නිසා අපට තිරගතවීම පවා කල් දැමීමට සිදු වුණා. ඔබට අවශ්‍ය පරිදි නියමිත වේලාවට තාක්ෂණික ලේඛකයින්ට කාර්යයන් භාර දෙන ලෙස ඔබට සැමගෙන් ඉල්ලා සිටිය හැකිය, නමුත් එය ක්‍රියා නොකරනු ඇත. ක්රියාවලිය ස්වයංක්රීය නොවේ නම්, තත්වය නැවත නැවතත් සිදුවනු ඇත.

අපි YouTrack වෙත වෙනස්කම් සිදු කර ඇත. නව විශේෂාංගයක් ගැන ලිපියක් ලිවීමේ කාර්යය තාක්ෂණික ලේඛකයා වෙත පැවරෙන්නේ විශේෂාංගය පරීක්ෂා කිරීමට පටන් ගන්නා මොහොතේම ය. එවිට ප්‍රවර්ධනය සඳහා සූදානම් වීම සඳහා අලෙවිකරණය ඒ ගැන ඉගෙන ගනී. දැනුම්දීම් Mattermost ආයතනික පණිවිඩකරු වෙත ද පැමිණේ, එබැවින් සංවර්ධකයින්ගේ ප්‍රවෘත්ති මඟ හැරීම සරලවම කළ නොහැක.

ලේඛන පරිශීලක ඉල්ලීම් පිළිබිඹු නොකරයි

අපි මේ වගේ වැඩ කිරීමට පුරුදු වී සිටිමු: විශේෂාංගයක් එළියට ආවා, අපි ඒ ගැන කතා කළා. අපි එය සක්‍රිය කරන්නේ කෙසේද, එය ක්‍රියා විරහිත කරන්නේ කෙසේද සහ හොඳින් ගැලපීම් කරන්නේ කෙසේදැයි අපි විස්තර කළෙමු. නමුත් සේවාදායකයෙක් අප බලාපොරොත්තු නොවූ ආකාරයෙන් අපගේ මෘදුකාංගය භාවිතා කරන්නේ නම් කුමක් කළ යුතුද? නැත්නම් අපි නොහිතපු වැරදි ඒකේ තියෙනවද?

ලේඛනගත කිරීම හැකි තරම් සම්පූර්ණ බව සහතික කිරීම සඳහා, අපි උපකාරක ඉල්ලීම්, තේමාත්මක සංසදවල ප්රශ්න සහ සෙවුම් යන්ත්රවල විමසුම් විශ්ලේෂණය කිරීම නිර්දේශ කරමු. වඩාත්ම ජනප්‍රිය මාතෘකා තාක්ෂණික ලේඛකයින් වෙත මාරු කරනු ලබන අතර එමඟින් ඔවුන්ට පවතින ලිපි අතිරේක කිරීමට හෝ නව ඒවා ලිවීමට හැකිය.

ප්‍රලේඛනය වැඩි දියුණු නොවේ

එය වහාම පරිපූර්ණ ලෙස කිරීම දුෂ්කර ය; තවමත් වැරදි සිදුවනු ඇත. ඔබට ගනුදෙනුකරුවන්ගෙන් ප්‍රතිපෝෂණ බලාපොරොත්තු විය හැක, නමුත් ඔවුන් සෑම අකුරු දෝෂයක්ම, සාවද්‍ය භාවයක්, තේරුම්ගත නොහැකි හෝ පදනම් විරහිත ලිපියක් වාර්තා කරනු ඇතැයි සිතිය නොහැක. සේවාදායකයින්ට අමතරව, සේවකයින් ලේඛන කියවන අතර එයින් අදහස් වන්නේ ඔවුන් එකම දෝෂ දකින බවයි. මෙය භාවිතා කළ හැකිය! ඔබට අවශ්‍ය වන්නේ ගැටලුවක් වාර්තා කිරීමට පහසු වන කොන්දේසි නිර්මානය කිරීමයි.

ලේඛනගත කිරීම පිළිබඳ සේවකයින් අදහස්, යෝජනා සහ අදහස් ඉදිරිපත් කරන අභ්‍යන්තර ද්වාරයෙහි කණ්ඩායමක් අප සතුව ඇත. සහායට ලිපියක් අවශ්‍යද, නමුත් එය නොපවතීද? පරීක්ෂකවරයා වැරදි බව දුටුවාද? හවුල්කරු දෝෂ පිළිබඳව සංවර්ධන කළමනාකරුවන්ට පැමිණිලි කර තිබේද? මෙම කණ්ඩායමේ සිටින සියල්ලෝම! තාක්ෂණික ලේඛකයින් සමහර දේවල් වහාම නිවැරදි කරයි, සමහර දේවල් YouTrack වෙත මාරු කරයි, සහ අනෙක් අයට සිතන්නට කාලය ලබා දෙයි. මාතෘකාව මිය යාම වැළැක්වීම සඳහා, අපි වරින් වර ඔබට කණ්ඩායමේ පැවැත්ම සහ ප්‍රතිපෝෂණවල වැදගත්කම මතක් කරමු.

ගැටලුව 3. නිවැරදි ලිපිය සොයා ගැනීමට බොහෝ කාලයක් ගත වේ.

සොයාගත නොහැකි ලිපියක් සොයාගත නොහැකි ලිපියකට වඩා හොඳ නැත. හොඳ ලේඛනවල ආදර්ශ පාඨය විය යුත්තේ "සෙවීමට පහසු, සොයා ගැනීමට පහසු" යන්නයි. මෙය සාක්ෂාත් කර ගන්නේ කෙසේද?

ව්යුහය සංවිධානය කිරීම සහ මාතෘකා තෝරා ගැනීම සඳහා මූලධර්මය තීරණය කරන්න. “මෙම ලිපිය මට සොයාගත හැක්කේ කොතැනින්ද?” යන්න පාඨකයා නොසිතන පරිදි ව්‍යුහය හැකි තරම් විනිවිද පෙනෙන විය යුතුය. සාරාංශ කිරීම සඳහා, ප්රවේශයන් දෙකක් තිබේ: අතුරු මුහුණත සහ කාර්යයන් වලින්.

1. අතුරු මුහුණතෙන්. අන්තර්ගතය පැනල කොටස් අනුපිටපත් කරයි. පැරණි ISP පද්ධති ලේඛනවල මෙය සිදු විය.
2. කාර්යයන් වලින්. ලිපි සහ කොටස්වල මාතෘකා පරිශීලකයින්ගේ කාර්යයන් පිළිබිඹු කරයි; මාතෘකා සෑම විටම පාහේ "කෙසේද" යන ප්‍රශ්නයට ක්‍රියාපද සහ පිළිතුරු අඩංගු වේ. දැන් අපි මේ ආකෘතියට යනවා.

ඔබ තෝරා ගන්නා ප්‍රවේශය කුමක් වුවත්, මාතෘකාව පරිශීලකයන් සොයන දෙයට අදාළ වන අතර පරිශීලකයාගේ ප්‍රශ්නය විශේෂයෙන් ආමන්ත්‍රණය කරන ආකාරයෙන් ආවරණය කර ඇති බවට වග බලා ගන්න.

මධ්යගත සෙවුමක් සකසන්න. පරමාදර්ශී ලෝකයක, ඔබ අක්ෂර වින්‍යාසය වැරදි වූ විට හෝ භාෂාව සමඟ වැරදීමක් සිදු කරන විට පවා සෙවීම ක්‍රියා කළ යුතුය. අපි මෙතෙක් Confluence හි සෙවීමට මෙය අපව සතුටු කළ නොහැක. ඔබට බොහෝ නිෂ්පාදන තිබේ නම් සහ ලේඛන සාමාන්‍ය නම්, පරිශීලකයා සිටින පිටුවට සෙවුම සකස් කරන්න. අපගේ නඩුවේදී, ප්‍රධාන පිටුවේ සෙවීම සියලුම නිෂ්පාදන සඳහා ක්‍රියාත්මක වන අතර, ඔබ දැනටමත් නිශ්චිත කොටසක සිටී නම්, එහි ඇති ලිපි සඳහා පමණි.

අන්තර්ගතය සහ යමඟ එකතු කරන්න. සෑම පිටුවකම මෙනුවක් සහ යමඟ ඇති විට එය හොඳයි - ඕනෑම මට්ටමකට ආපසු යාමට හැකියාව ඇති වත්මන් පිටුවට පරිශීලකයාගේ මාර්ගය. පැරණි ISP පද්ධති ප්‍රලේඛනය තුළ, ඔබට අන්තර්ගතය වෙත යාමට ලිපියෙන් පිටවීමට සිදු විය. එය අපහසුතාවයක්, ඒ නිසා අපි එය අලුත් එකේ සවි කළා.

නිෂ්පාදනයේ සබැඳි තබන්න. එකම ප්‍රශ්නය සමඟ මිනිසුන් නැවත නැවතත් සහාය දීමට පැමිණෙන්නේ නම්, අතුරු මුහුණතට එහි විසඳුම සමඟ ඉඟියක් එක් කිරීම අර්ථවත් කරයි. පරිශීලකයෙකු ගැටලුවක් අත්විඳින විට ඔබට දත්ත හෝ තීක්ෂ්ණ බුද්ධියක් තිබේ නම්, ඔබට තැපැල් ලැයිස්තුවක් සමඟින් ඔවුන්ට දැනුම් දිය හැක. ඔවුන්ට සැලකිල්ල පෙන්වන්න සහ සහයෝගයෙන් බර ඉවත් කරන්න.

උත්පතන කවුළුවේ දකුණු පසින් ISPmanager හි වසම් කළමනාකරණ අංශයේ DNSSEC පිහිටුවීම පිළිබඳ ලිපියකට සබැඳියක් ඇත.

ලේඛන තුළ හරස් යොමු සකසන්න. එකිනෙකට සම්බන්ධ ලිපි "සම්බන්ධ" විය යුතුය. ලිපි අනුක්‍රමික නම්, එක් එක් පාඨය අවසානයේ ඉදිරියට සහ පසුපසට ඊතල එක් කිරීමට වග බලා ගන්න.

බොහෝ දුරට ඉඩ ඇති පරිදි, පුද්ගලයෙකු මුලින්ම ඔහුගේ ප්‍රශ්නයට පිළිතුරක් සොයන්නේ ඔබට නොව සෙවුම් යන්ත්‍රයකට ය. තාක්ෂණික හේතූන් මත එහි ලේඛනවලට සබැඳි නොමැති නම් එය ලැජ්ජාවකි. එබැවින් සෙවුම් යන්ත්‍ර ප්‍රශස්තකරණය ගැන සැලකිලිමත් වන්න.

ගැටළුව 4. යල් පැන ගිය පිරිසැලසුම සංජානනයට බාධා කරයි

නරක පාඨ වලට අමතරව, ලේඛන නිර්මාණය මගින් නරක් විය හැක. මිනිසුන් හොඳින් ලියා ඇති ලිපි කියවීමට පුරුදු වී සිටිති. බ්ලොග්, සමාජ ජාල, මාධ්‍ය - සියලුම අන්තර්ගතයන් ඉදිරිපත් කර ඇත්තේ අලංකාර පමණක් නොව, කියවීමට පහසු සහ ඇසට ප්‍රසන්නය. ඒ නිසා පහල Screenshot එකේ වගේ Text එක දකින කෙනෙක්ගේ වේදනාව ඔයාලට ලේසියෙන් තේරුම් ගන්න පුළුවන්.

මෙම ලිපියේ බොහෝ තිරපිටපත් සහ උද්දීපනයන් ඇති අතර ඒවා උදව් නොකරන නමුත් සංජානනයට පමණක් බාධා කරයි (පින්තූරය ක්ලික් කළ හැකිය)

ඔබ බලපෑම් පොකුරක් සමඟ ලේඛනයෙන් දීර්ඝ කියවීමක් නොකළ යුතුය, නමුත් ඔබ මූලික නීති සැලකිල්ලට ගත යුතුය.

පිරිසැලසුම. ශරීර පෙළ පළල, අකුරු, ප්‍රමාණය, ශීර්ෂයන් සහ පිරවුම තීරණය කරන්න. නිර්මාණකරුවෙකු බඳවා ගන්න, කාර්යය භාර ගැනීමට හෝ එය ඔබම කිරීමට, Artyom Gorbunov ගේ "මුද්රණ ශිල්පය සහ පිරිසැලසුම" පොත කියවන්න. එය පිරිසැලසුමෙහි එක් දර්ශනයක් පමණක් ඉදිරිපත් කරයි, නමුත් එය සෑහෙන තරම් ප්රමාණවත්ය.

ප්රතිපාදන. පෙළෙහි අවධාරණය කළ යුතු දේ තීරණය කරන්න. සාමාන්යයෙන් මෙය අතුරු මුහුණත, බොත්තම්, කේත ඇතුළු කිරීම්, වින්යාස ගොනු, "කරුණාකර සටහන් කරන්න" බ්ලොක් වල මාර්ගයකි. මෙම මූලද්‍රව්‍යවල ප්‍රතිපාදන මොනවාද යන්න තීරණය කර ඒවා රෙගුලාසිවල සටහන් කරන්න. අඩු විසර්ජනය, වඩා හොඳ බව මතක තබා ගන්න. ගොඩක් එවුන් ඉන්නකොට text එක ඝෝෂාකාරී. උද්ධෘත ලකුණු පවා නිතර භාවිතා කරන්නේ නම් ශබ්දය ඇති කරයි.

රූප රාමු. තිරපිටපත් අවශ්‍ය වන්නේ කුමන අවස්ථාවලදීද යන්න කණ්ඩායම සමඟ එකඟ වන්න. සෑම පියවරක්ම නිදර්ශනය කිරීම අවශ්ය නොවේ. තිරපිටපත් විශාල සංඛ්‍යාවක්, ඇතුළුව. වෙනම බොත්තම්, සංජානනයට බාධා කරන්න, පිරිසැලසුම නරක් කරන්න. ප්‍රමාණය තීරණය කරන්න, තිරපිටපත්වල උද්දීපනය සහ අත්සන් වල ආකෘතිය මෙන්ම ඒවා රෙගුලාසි වල සටහන් කරන්න. නිදර්ශන සෑම විටම ලියා ඇති දේට අනුරූප විය යුතු අතර අදාළ විය යුතු බව මතක තබා ගන්න. නැවතත්, නිෂ්පාදිතය නිතිපතා යාවත්කාලීන කරන්නේ නම්, සෑම කෙනෙකුම නිරීක්ෂණය කිරීමට අපහසු වනු ඇත.

පෙළ දිග. ඕනෑවට වඩා දිගු ලිපි වලින් වළකින්න. ඒවා කොටස් වලට කඩන්න, මෙය කළ නොහැකි නම්, ලිපියේ ආරම්භයට නැංගුරම් සබැඳි සමඟ අන්තර්ගතය එක් කරන්න. ලිපියක් දෘශ්‍යමය වශයෙන් කෙටි කිරීමට සරල ක්‍රමයක් නම් පටු පාඨක කවයකට අවශ්‍ය තාක්ෂණික තොරතුරු ස්පොයිලර් යටතේ සැඟවීමයි.

ආකෘති. ඔබේ ලිපිවල ආකෘති කිහිපයක් ඒකාබද්ධ කරන්න: පෙළ, වීඩියෝ සහ පින්තූර. මෙය සංජානනය වැඩිදියුණු කරනු ඇත.

අලංකාර පිරිසැලසුම සමඟ ගැටළු වසන් කිරීමට උත්සාහ නොකරන්න. අවංකවම, “දවටනය” යල් පැන ගිය ලියකියවිලි සුරකිනු ඇතැයි අපි බලාපොරොත්තු වෙමු - එය සාර්ථක වූයේ නැත. මෙම පාඨවල දෘශ්‍ය ඝෝෂාව සහ අනවශ්‍ය තොරතුරු අඩංගු වූ අතර රෙගුලාසි සහ නව නිර්මාණය බල රහිත විය.

ඉහත බොහෝ දේ තීරණය වන්නේ ඔබ ලේඛනගත කිරීම සඳහා භාවිතා කරන වේදිකාව මගිනි. උදාහරණයක් ලෙස, අපට Confluence ඇත. මටත් ඔහු සමඟ ටින්කර් කිරීමට සිදු විය. කැමති නම්, අපගේ වෙබ් සංවර්ධකයාගේ කතාව කියවන්න: පොදු දැනුම් පදනමක් සඳහා එකමුතුව: නිර්මාණය වෙනස් කිරීම සහ භාෂා අනුව වෙන් කිරීම සැකසීම.

වැඩිදියුණු කිරීම ආරම්භ කළ යුත්තේ කොතැනින්ද සහ ජීවත් වන්නේ කෙසේද

ඔබගේ ලේඛන ISP පද්ධතිය තරම් විශාල නම් සහ ඔබ ආරම්භ කළ යුත්තේ කොතැනින්දැයි නොදන්නේ නම්, විශාලතම ගැටළු සමඟ ආරම්භ කරන්න. සේවාදායකයින්ට ලේඛනය තේරෙන්නේ නැත - පෙළ වැඩි දියුණු කිරීම, රෙගුලාසි සකස් කිරීම, ලේඛකයින් පුහුණු කිරීම. ලේඛනගත කිරීම කල් ඉකුත් වී ඇත - අභ්යන්තර ක්රියාවලීන් ගැන සැලකිලිමත් වන්න. වඩාත්ම ජනප්‍රිය නිෂ්පාදන පිළිබඳ වඩාත් ජනප්‍රිය ලිපි සමඟ ආරම්භ කරන්න: සහාය විමසන්න, අඩවි විශ්ලේෂණ සහ සෙවුම් යන්ත්‍රවල විමසුම් බලන්න.

අපි වහාම කියමු - එය පහසු නොවනු ඇත. තවද එය ඉක්මනින් ක්‍රියාත්මක වීමටද අපහසුය. ඔබ ආරම්භ කර හරි දේ වහාම කරන්නේ නම් මිස. අපි නිසැකවම දන්නා දෙයක් නම් එය කාලයත් සමඟ හොඳ අතට හැරෙන බවයි. නමුත් ක්රියාවලිය අවසන් නොවේ :-).

මූලාශ්රය: www.habr.com