ඩොක්යුමේන්ටේෂන් ලේඛන බොහෝ වෙලාවේ වැරදි ප්රශ්නයකට පිළිතුරු දෙයි. කියවන්නන්ට අවශ්යය "මෙතනින් ආරම්භ කරන්න" කියන මාර්ගෝපදේශයක් වෙනුවට, අපි එම ලේඛනවල සම්පූර්ණ කෝෂයක් හදාගෙන තියෙන්නේ. මේක නිසා ලොකු ගොනුවක් පවතිනවාමයි, නමුත් අවශ්ය තොරතුරට පාරිභෝගිකයාට මග හොයාගන්න බැරි වෙයි. මේ ප්රශ්නයට විසඳුමක් ලෙස "doc‑audit" නමැති CLI මෙවලම හඳුන්වා දෙනවා.
doc‑audit එක markdown ගොනු කියවලා, ඒවා තීරණ‑දියුණුවේ කොටස් (Day 0, Day 1, Day 2) අනුව වර්ගීකරණය කරයි. එමගින් ලේඛනය කියවන්නාට කාර්යයක් කර ගැනීමට මඟ පෙන්වීමේ ගුණාත්මකත්වය මැනේ. පසුබැසීමේදී මෙය වැඩිදුර සංස්කරණය කිරීමේ අවශ්යතාවයන්ට ප්රාථමික ලැයිස්තුවක් ලබා දෙයි. මෙවලම භාවිතා කරන්නේ Node.js 18+ සහ git repository එකක් clone කරලා, npm install කරලා, npm link කරලා doc‑audit command එක ඕනෑම .md ෆෝල්ඩරයක ධාවනය කිරීමෙන්.
මෙම ප්රවේශය තීරණ‑මාරුකරණය කරන පරිශීලකයන්ට මාර්ගෝපදේශයක් සපයයි. Day 0 (Pre‑Commitment) තුළ පරිශීලකයා තේරුම් ගත යුතුය – මෙය මගේ අවශ්යතාවයට ගැලපේද? Day 1 (Getting Started) තුළ ඉක්මනින් වැඩ පටන් ගන්නා පියවර, default configuration, සාර්ථකත්වය පරීක්ෂා කිරීම. Day 2 (Production) තුළ ගැටලු විසඳීම, scale‑up, runbook‑s වැනි අංගයන් අඩංගු වේ. එමෙන්ම, මනුෂ්ය පරිශීලකයා සහ ඒකක‑පාලක (agent) අතර අවශ්යතා වෙනස් වන බැවින්, ලේඛනයේ පැහැදිලි next‑step, decision‑point, context‑free වශයෙන් ලියැවිය යුතුය.
ශ්රී ලංකාවට ඇති වැදගත්කම
ශ්රී ලංකාවේ තාක්ෂණික විද්යාල සිසුන්, මෘදුකාංග සංවර්ධකයන්, ව්යාපාරිකයින්ට මෙම මෙවලම ප්රයෝජනවත් වේ. සිසුන්ට ලේඛන පරීක්ෂා කිරීමේ ක්රමවේදය ඉගෙන ගත හැකි අතර, ප්රායෝගික වශයෙන් open‑source CLI භාවිතය ඉගෙන ගත හැක. සංවර්ධකයන්ට තමන්ගේ API documentation, SDK guide, internal knowledge‑base වැනි ලේඛන පද්ධති ඉක්මනින් audit කර, භාවිතා කරන්නන්ට නිවැරදි මාර්ගෝපදේශයක් සපයනවා. ව්යාපාරිකයින්ට අතුරුදන්වූ තීරණ‑පියවර නිසා පාරිභෝගික අහිමි වීමේ අවදානම අඩු වේ, support ticket ගණන අඩු කරයි, ඉදිරියට යාමට නවීන automation පද්ධති ඉදිරිපත් කරයි.
අවසන් වශයෙන්, doc‑audit එක ලේඛන ගොනුවල “බුද්ධිමත් නාවික” පද්ධතියක් බවට පත්වෙයි. ඔබේ documentation එක තීරණ‑කාර්ය මණ්ඩලයක් බවට පත් කරගෙන, පරිශීලකයින්ට වේගයෙන්, නිවැරදිව, අවශ්ය තොරතුරට පසුබැසීමේ අඩුවක් ලබා දෙන්න.
