ஆவணப்படுத்துதல் என்பது ஒரு அம்சம்
ஆவணப்படுத்துதல் என்பது உங்கள் தயாரிப்பிலிருந்து தனிப்பயானது அல்ல. அது தயாரிப்பின் ஒரு பகுதியாகும்.
பல டெவலப்பர்கள் ஒரு தவறான முறையைப் பின்பற்றுகிறார்கள்:
- அம்சத்தை உருவாக்குங்கள்.
- அம்சத்தை சோதியுங்கள்.
- அம்சத்தை வெளியிடுங்கள்.
- அம்சத்தைப் ஆவணப்படுத்துங்கள்.
பயனர்கள் உங்கள் குறியீட்டை (code) அனுபவிப்பதில்லை. அவர்கள் உங்கள் இடைமுகம் (interface), உங்கள் பணிப்பாய்வுகள் (workflows) மற்றும் உங்கள் ஆவணங்களைத்தான் அனுபவிக்கிறார்கள். ஒரு பயனரைப் பொறுத்தவரை, ஆவணப்படுத்துதல் என்பது ஒரு அம்சமாகும்.
படைப்பாளர்கள் ஆவணப்படுத்துதலை அலட்சியப்படுத்துகிறார்கள், ஏனெனில் அவர்களுக்கு ஏற்கனவே தயாரிப்பு பற்றித் தெரியும். நீங்கள் ஏன் சில முடிவுகளை எடுத்தீர்கள் என்பது உங்களுக்குத் தெரியும். API எவ்வாறு செயல்படுகிறது என்பது உங்களுக்குத் தெரியும். குறுக்குவழிகள் (shortcuts) உங்களுக்குத் தெரியும்.
பயனருக்கு அது தெரியாது. உங்களுக்குத் தெளிவான விஷயம் அவர்களுக்கு மர்மமாகத் தெரியலாம்.
மீண்டும் மீண்டும் கேட்கப்படும் கேள்விகளை ஆவணக் கடனாக (documentation debt) கருதுங்கள். மக்கள் ஒரே கேள்வியை இரண்டு முறை கேட்டால், உங்களுக்கு ஒரு பிரச்சனை இருக்கிறது என்று அர்த்தம். ஒன்று உங்கள் தயாரிப்பு குழப்பமளிப்பதாக இருக்கலாம் அல்லது உங்கள் ஆவணங்கள் முழுமையற்றதாக இருக்கலாம். சில நேரங்களில் நீங்கள் API-ஐ சரிசெய்ய வேண்டியிருக்கும். பெரும்பாலும், நீங்கள் ஆவணங்களைச் சரிசெய்ய வேண்டியிருக்கும்.
சிறந்த ஆவணப்படுத்துதல் தடைகளைக் (friction) குறைக்கிறது. இது பின்வரும் கேள்விகளுக்கு விரைவாகப் பதிலளிக்கிறது:
- இது என்ன?
- நான் ஏன் இதைப் பயன்படுத்த வேண்டும்?
- நான் எப்படித் தொடங்குவது?
- சிறந்த அணுகுமுறை எது?
- ஒரு எளிய உதாரணம் என்ன?
இலக்கு முழுமையடைவது மட்டுமல்ல. இலக்கு வேகத்தைத் (momentum) தொடர்வதாகும்.
சிறந்த ஆவணப்படுத்துதல் முறைகளையும் நோக்கத்தையும் கற்பிக்கிறது. ஒரு framework ஏன் ஒரு குறிப்பிட்ட வழியில் செயல்படுகிறது என்பதை அது விளக்குகிறது. இது பயனர்களை மிகவும் திறம்படச் செயல்பட வைக்கிறது.
ஆவணப்படுத்துதல் உங்கள் வணிகத்தில் அமைதியான வழிகளில் தாக்கத்தை ஏற்படுத்துகிறது:
- பயன்பாட்டு விகிதங்கள் (Adoption rates).
- ஆன்போர்டிங் வேகம் (Onboarding speed).
- ஆதரவுச் செலவுகள் (Support costs).
- சமூக வளர்ச்சி (Community growth).
- டெவலப்பர் அனுபவம் (Developer experience).
சிறந்த ஆவணங்களின் தாக்கத்தை உங்களால் எளிதில் காண முடியாது. ஆனால் மோசமான ஆவணங்களின்மையைக் கண்டால் உடனடியாகத் தெரிந்துவிடும்.
ஆவணப்படுத்துதல் உங்களுக்காகவும் என்பதை நினைவில் கொள்ளுங்கள். இது உங்கள் அறிவை எதிர்காலத் தேவைகளுக்காகப் பாதுகாக்கிறது. இது முடிவுகளைப் பதிவு செய்கிறது, இதனால் மாதங்களுக்குப் பிறகு நீங்கள் மீண்டும் பதில்களைத் தேட வேண்டிய அவசியம் இருக்காது.
தயாரிப்பின் தரமும் ஆவணப்படுத்துதலின் தரமும் ஒன்றோடொன்று இணைக்கப்பட்டுள்ளன.
- குழப்பமான மென்பொருளுக்கு அதிக ஆவணங்கள் தேவைப்படுகின்றன.
- தெளிவான மென்பொருளுக்குக் குறைவான ஆவணங்களே போதும்.
- சிறந்த ஆவணப்படுத்துதல் மோசமான வடிவமைப்பைக் கண்டறிய உதவுகிறது.
ஆவணப்படுத்துதலை ஒரு கூடுதல் விஷயமாகக் கருதுவதை நிறுத்துங்கள். தெளிவை உருவாக்க அதைப் பயன்படுத்துங்கள். தெளிவு உங்கள் வடிவமைப்பை மேம்படுத்துகிறது. மேம்பட்ட வடிவமைப்பு உங்கள் தயாரிப்பை மேம்படுத்துகிறது.
மூலம்: https://dev.to/stinklewinks/documentation-is-a-feature-228n