𝗗𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝗜𝘀 𝗔 𝗙𝗲𝗮𝘁𝘂𝗿𝗲 ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಒಂದು ವೈಶಿಷ್ಟ್ಯ
ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ನಿಮ್ಮ ಉತ್ಪನ್ನದಿಂದ ಪ್ರತ್ಯೇಕವಾದುದಲ್ಲ. ಇದು ಉತ್ಪನ್ನದ ಒಂದು ಭಾಗವಾಗಿದೆ.
ಅನೇಕ ಡೆವಲಪರ್ಗಳು ಒಂದು ದೋಷಪೂರಿತ ಮಾದರಿಯನ್ನು ಅನುಸರಿಸುತ್ತಾರೆ:
- ವೈಶಿಷ್ಟ್ಯವನ್ನು ನಿರ್ಮಿಸಿ.
- ವೈಶಿಷ್ಟ್ಯವನ್ನು ಪರೀಕ್ಷಿಸಿ.
- ವೈಶಿಷ್ಟ್ಯವನ್ನು ಬಿಡುಗಡೆ ಮಾಡಿ.
- ವೈಶಿಷ್ಟ್ಯದ ಬಗ್ಗೆ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಮಾಡಿ.
ಬಳಕೆದಾರರು ನಿಮ್ಮ ಕೋಡ್ ಅನ್ನು ಅನುಭವಿಸುವುದಿಲ್ಲ. ಅವರು ನಿಮ್ಮ ಇಂಟರ್ಫೇಸ್, ನಿಮ್ಮ ವರ್ಕ್ಫ್ಲೋಗಳು ಮತ್ತು ನಿಮ್ಮ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಅನ್ನು ಅನುಭವಿಸುತ್ತಾರೆ. ಒಬ್ಬ ಬಳಕೆದಾರರಿಗೆ, ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಎಂಬುದು ಒಂದು ವೈಶಿಷ್ಟ್ಯವೇ ಆಗಿದೆ.
ಸೃಷ್ಟಿಕರ್ತರು ಉತ್ಪನ್ನವನ್ನು ಈಗಾಗಲೇ ಅರ್ಥಮಾಡಿಕೊಂಡಿರುವುದರಿಂದ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಅನ್ನು ನಿರ್ಲಕ್ಷಿಸುತ್ತಾರೆ. ನೀವು ಕೆಲವು ನಿರ್ಧಾರಗಳನ್ನು ಏಕೆ ತೆಗೆದುಕೊಂಡಿದ್ದೀರಿ ಎಂಬುದು ನಿಮಗೆ ತಿಳಿದಿದೆ. API ಹೇಗೆ ಕೆಲಸ ಮಾಡುತ್ತದೆ ಎಂಬುದು ನಿಮಗೆ ತಿಳಿದಿದೆ. ಶಾರ್ಟ್ಕಟ್ಗಳು ನಿಮಗೆ ತಿಳಿದಿವೆ.
ಬಳಕೆದಾರರಿಗೆ ಇದು ತಿಳಿದಿರುವುದಿಲ್ಲ. ನಿಮಗೆ ಸ್ಪಷ್ಟವಾಗಿ ಕಾಣುವ ವಿಷಯವು ಅವರಿಗೆ ನಿಗೂಢವಾಗಿ ಕಾಣಬಹುದು.
ಪದೇ ಪದೇ ಕೇಳಲಾಗುವ ಪ್ರಶ್ನೆಗಳನ್ನು 'ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಸಾಲ' (documentation debt) ಎಂದು ಪರಿಗಣಿಸಿ. ಜನರು ಒಂದೇ ಪ್ರಶ್ನೆಯನ್ನು ಎರಡು ಬಾರಿ ಕೇಳಿದರೆ, ಅಲ್ಲಿ ನಿಮಗೆ ಸಮಸ್ಯೆಯಿದೆ ಎಂದರ್ಥ. ನಿಮ್ಮ ಉತ್ಪನ್ನವು ಗೊಂದಲಮಯವಾಗಿರಬಹುದು ಅಥವಾ ನಿಮ್ಮ ಡಾಕ್ಯುಮೆಂಟ್ಸ್ ಅಪೂರ್ಣವಾಗಿರಬಹುದು. ಕೆಲವೊಮ್ಮೆ ನೀವು API ಅನ್ನು ಸರಿಪಡಿಸಬೇಕಾಗುತ್ತದೆ. ಹೆಚ್ಚಾಗಿ, ನೀವು ಡಾಕ್ಯುಮೆಂಟ್ಸ್ ಅನ್ನು ಸರಿಪಡಿಸಬೇಕಾಗುತ್ತದೆ.
ಉತ್ತಮ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಅಡೆತಡೆಗಳನ್ನು ಕಡಿಮೆ ಮಾಡುತ್ತದೆ. ಇದು ಈ ಪ್ರಶ್ನೆಗಳಿಗೆ ತ್ವರಿತವಾಗಿ ಉತ್ತರಿಸುತ್ತದೆ:
- ಇದು ಏನು?
- ನಾನು ಇದನ್ನು ಏಕೆ ಬಳಸಬೇಕು?
- ನಾನು ಹೇಗೆ ಪ್ರಾರಂಭಿಸಬೇಕು?
- ಅತ್ಯುತ್ತಮ ವಿಧಾನ ಯಾವುದು?
- ಒಂದು ಸರಳ ಉದಾಹರಣೆ ಯಾವುದು?
ಗುರಿ ಪರಿಪೂರ್ಣತೆಯಲ್ಲ. ಗುರಿ ಗತಿ (momentum).
ಅತ್ಯುತ್ತಮ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಮಾದರಿಗಳು ಮತ್ತು ಉದ್ದೇಶಗಳನ್ನು ಕಲಿಸುತ್ತದೆ. ಒಂದು ಫ್ರೇಮ್ವರ್ಕ್ ಏಕೆ ಒಂದು ನಿರ್ದಿಷ್ಟ ರೀತಿಯಲ್ಲಿ ಕೆಲಸ ಮಾಡುತ್ತದೆ ಎಂಬುದನ್ನು ಇದು ವಿವರಿಸುತ್ತದೆ. ಇದು ಬಳಕೆದಾರರನ್ನು ಹೆಚ್ಚು ಪರಿಣಾಮಕಾರಿಯಾಗಿ ಮಾಡುತ್ತದೆ.
ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ನಿಮ್ಮ ವ್ಯವಹಾರದ ಮೇಲೆ ಮೌನವಾಗಿ ಪ್ರಭಾವ ಬೀರುತ್ತದೆ:
- ಅಳವಡಿಕೆಯ ದರಗಳು (Adoption rates).
- ಆನ್ಬೋರ್ಡಿಂಗ್ ವೇಗ (Onboarding speed).
- ಬೆಂಬಲ ವೆಚ್ಚಗಳು (Support costs).
- ಸಮುದಾಯದ ಬೆಳವಣಿಗೆ (Community growth).
- ಡೆವಲಪರ್ ಅನುಭವ (Developer experience).
ಉತ್ತಮ ಡಾಕ್ಯುಮೆಂಟ್ಸ್ನ ಪ್ರಭಾವವನ್ನು ನೀವು ಸುಲಭವಾಗಿ ನೋಡಲು ಸಾಧ್ಯವಿಲ್ಲ. ಆದರೆ ಕೆಟ್ಟ ಡಾಕ್ಯುಮೆಂಟ್ಸ್ನ ಕೊರತೆಯನ್ನು ನೀವು ತಕ್ಷಣವೇ ಗಮನಿಸಬಹುದು.
ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ನಿಮಗಾಗಿಯೂ ಎಂಬುದು ನೆನಪಿರಲಿ. ಇದು ನಿಮ್ಮ ಭವಿಷ್ಯದ ಆವೃತ್ತಿಗಳಿಗಾಗಿ ನಿಮ್ಮ ಜ್ಞಾನವನ್ನು ಸಂರಕ್ಷಿಸುತ್ತದೆ. ಇದು ನಿರ್ಧಾರಗಳನ್ನು ದಾಖಲಿಸುತ್ತದೆ, ಇದರಿಂದಾಗಿ ನೀವು ತಿಂಗಳುಗಳ ನಂತರ ಮತ್ತೆ ಉತ್ತರಗಳನ್ನು ಹುಡುಕಬೇಕಾಗಿ ಬರುವುದಿಲ್ಲ.
ಉತ್ಪನ್ನದ ಗುಣಮಟ್ಟ ಮತ್ತು ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಗುಣಮಟ್ಟವು ಪರಸ್ಪರ ಸಂಬಂಧ ಹೊಂದಿವೆ.
- ಗೊಂದಲಮಯ ಸಾಫ್ಟ್ವೇರ್ಗೆ ಹೆಚ್ಚಿನ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಬೇಕಾಗುತ್ತದೆ.
- ಸ್ಪಷ್ಟವಾದ ಸಾಫ್ಟ್ವೇರ್ಗೆ ಕಡಿಮೆ ಬೇಕಾಗುತ್ತದೆ.
- ಉತ್ತಮ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಕೆಟ್ಟ ವಿನ್ಯಾಸವನ್ನು ಎತ್ತಿ ತೋರಿಸುತ್ತದೆ.
ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಅನ್ನು ಕೇವಲ ನಂತರದ ಕೆಲಸ ಎಂದು ಪರಿಗಣಿಸುವುದನ್ನು ನಿಲ್ಲಿಸಿ. ಸ್ಪಷ್ಟತೆಯನ್ನು ತರಲು ಅದನ್ನು ಬಳಸಿ. ಸ್ಪಷ್ಟತೆಯು ನಿಮ್ಮ ವಿನ್ಯಾಸವನ್ನು ಸುಧಾರಿಸುತ್ತದೆ. ಸುಧಾರಿತ ವಿನ್ಯಾಸವು ನಿಮ್ಮ ಉತ್ಪನ್ನವನ್ನು ಸುಧಾರಿಸುತ್ತದೆ.
Source: https://dev.to/stinklewinks/documentation-is-a-feature-228n