डॉक्युमेंटेशन हे एक फिचर आहे

डॉक्युमेंटेशन तुमच्या उत्पादनापासून वेगळे नसते. ते उत्पादनाचाच एक भाग आहे.

अनेक डेव्हलपर्स एका चुकीच्या पद्धतीचे अनुसरण करतात:

  • फिचर तयार करा.
  • फिचर टेस्ट करा.
  • फिचर रिलीज करा.
  • फिचरचे डॉक्युमेंटेशन करा.

वापरकर्ते तुमच्या कोडचा अनुभव घेत नाहीत. ते तुमच्या इंटरफेसचा, तुमच्या वर्कफ्लोचा आणि तुमच्या डॉक्युमेंटेशनचा अनुभव घेतात. वापरकर्त्यासाठी, डॉक्युमेंटेशन हे एक फिचर आहे.

निर्माते डॉक्युमेंटेशनकडे दुर्लक्ष करतात कारण त्यांना उत्पादन आधीच समजलेले असते. तुम्ही काही विशिष्ट निर्णय का घेतले हे तुम्हाला माहित असते. API कसे कार्य करते हे तुम्हाला माहित असते. तुम्हाला शॉर्टकट माहित असतात.

वापरकर्त्याला हे माहित नसते. जे तुम्हाला स्पष्ट वाटते, ते त्यांना अनाकलनीय वाटते.

वारंवार विचारल्या जाणाऱ्या प्रश्नांना 'डॉक्युमेंटेशन डेट' (documentation debt) समजा. जर लोक तोच प्रश्न दोनदा विचारत असतील, तर तुमची काहीतरी चूक आहे. एकतर तुमचे उत्पादन गोंधळात टाकणारे आहे किंवा तुमचे डॉक्युमेंटेशन अपूर्ण आहे. कधीकधी तुम्हाला API मध्ये सुधारणा करण्याची गरज असते, तर अनेकदा तुम्हाला डॉक्युमेंटेशनमध्ये सुधारणा करण्याची गरज असते.

चांगले डॉक्युमेंटेशन अडथळे कमी करते. ते या प्रश्नांची झटपट उत्तरे देते:

  • हे काय आहे?
  • मी याचा वापर का करावा?
  • मी सुरुवात कशी करू?
  • सर्वोत्तम दृष्टिकोन कोणता आहे?
  • एक सोपे उदाहरण काय आहे?

ध्येय पूर्णता मिळवणे हे नाही, तर गती (momentum) मिळवणे हे आहे.

उत्कृष्ट डॉक्युमेंटेशन पॅटर्न आणि हेतू शिकवते. एखादे फ्रेमवर्क विशिष्ट पद्धतीने का कार्य करते, हे ते स्पष्ट करते. यामुळे वापरकर्ते अधिक प्रभावी ठरतात.

डॉक्युमेंटेशन तुमच्या व्यवसायावर शांतपणे परिणाम करते:

  • ॲडॉपशन रेट्स (Adoption rates).
  • ऑनबोर्डिंगचा वेग (Onboarding speed).
  • सपोर्ट खर्च (Support costs).
  • कम्युनिटीची वाढ (Community growth).
  • डेव्हलपर अनुभव (Developer experience).

चांगल्या डॉक्युमेंटेशनचा प्रभाव सहजपणे दिसून येत नाही. परंतु खराब डॉक्युमेंटेशनच्या अभावामुळे होणारा त्रास लगेच जाणवतो.

लक्षात ठेवा की डॉक्युमेंटेशन तुमच्यासाठी देखील आहे. ते तुमच्या भविष्यातील आवृत्तीसाठी तुमचे ज्ञान जतन करते. ते निर्णय नोंदवून ठेवते जेणेकरून तुम्हाला महिन्यांनंतर पुन्हा उत्तरे शोधण्याची गरज पडणार नाही.

उत्पादनाची गुणवत्ता आणि डॉक्युमेंटेशनची गुणवत्ता एकमेकांशी जोडलेली आहे.

  • गोंधळात टाकणाऱ्या सॉफ्टवेअरला अधिक डॉक्युमेंटेशनची गरज असते.
  • स्पष्ट सॉफ्टवेअरला कमी डॉक्युमेंटेशन लागते.
  • चांगले डॉक्युमेंटेशन खराब डिझाइन उघड करते.

डॉक्युमेंटेशनकडे केवळ 'नंतरचा विचार' (afterthought) म्हणून पाहणे थांबवा. स्पष्टता आणण्यासाठी त्याचा वापर करा. स्पष्टतेमुळे तुमचे डिझाइन सुधारते आणि सुधारित डिझाइनमुळे तुमचे उत्पादन सुधारते.

स्त्रोत: https://dev.to/stinklewinks/documentation-is-a-feature-228n