विनामूल्य आणि मुक्त सॉफ्टवेअर विकसित करण्यासाठी चांगल्या पद्धती: दस्तऐवजीकरण

La दस्तऐवज एक मूलभूत भाग आहे आणि पाहिजे सर्जनशील प्रक्रिया आणि नियोजन सर्व मानवी क्रियाकलाप आणि विशेषत: तंत्रज्ञान क्षेत्रात सॉफ्टवेअर विकास.

El सर्व कागदपत्रांचा हेतू तो त्याला असणे आवश्यक आहे तृतीय पक्ष (वापरकर्ते, प्रशासक, देखभालकर्ता किंवा अन्य विकसक) शिकवा, ज्यांना सहसा परिचित नाही उत्पादन (कोड, अनुप्रयोग किंवा प्रणाली), ते कसे तयार केले जाते त्याची रचना, त्याचे ऑपरेशन आणि शक्य असल्यास देखील, त्याच्या निर्मितीचे कारण आणि त्याची रचना आणि कार्यप्रणाली.

शिवाय, च्या विशिष्ट बाबतीत विनामूल्य सॉफ्टवेअर दस्तऐवजीकरण आवश्यक आहे, कारण ती पूर्णपणे हमी देते ज्ञान हस्तांतरण आणि सबलीकरण च्या समाधानकारक पूर्तीसाठी आवश्यक 4 स्वातंत्र्य त्याद्वारे प्रचारित,

• 0: तुम्हाला पाहिजे असणारा कार्यक्रम कोणत्याही हेतूने चालवण्याचे स्वातंत्र्य.
• 1: एखाद्या प्रोग्राममध्ये प्रवेश करण्याचा आणि अभ्यास करण्याचे स्वातंत्र्य आणि आपल्या स्वतःच्या फायद्यासाठी त्यास बदलू किंवा अनुकूल करा.
• 2: समान सामायिक करण्यासाठी आणि / किंवा इतरांना मदत करण्यासाठी प्रती सामायिक करण्याचे किंवा पुन्हा वितरित करण्याचे स्वातंत्र्य.
• 3: आपल्या सुधारित आवृत्त्यांच्या प्रती तृतीय पक्षास वितरीत करण्याचे स्वातंत्र्य.

एक चांगला दस्तऐवजीकरण यामुळे तयार केलेले उत्पादन शक्य करते:

• हे योग्यरित्या वापरले जाते आणि ते अधिक सहजपणे शिकवले आणि शिकले जाते.
• ज्यांना ते सुधारण्यासाठी किंवा परिस्थितीशी जुळवून घेण्याची इच्छा आहे त्यांच्याकडून पूर्णपणे समजून घ्या.
• सर्व संभाव्य परिचित आणि अनोळखी लोकांमध्ये अधिक आत्मविश्वासाने सामायिक आणि प्राप्त करा.
• जनतेत अधिक चांगला जनसामानं मिळवा.

चांगल्या सराव: दस्तऐवजीकरण

मूलतत्त्वे

च्या बाबतीत मुक्त सॉफ्टवेअर व मुक्त स्रोतांचा विकाससामान्यत: दस्तऐवजीकरण मुख्य वापरकर्ते उत्पादन डिझाइनशी संबंधित, जे आहेत किंवा असतील त्या आहेत देखभाल जबाबदार समान. आणि चांगले किंवा कोणतेही दस्तऐवजीकरण न करता, थेट व्यवहार शोधणे, प्राप्त करणे हा एकमेव व्यवहार्य पर्याय आहे त्याची रचना आणि कार्य समजून घ्या.

जेव्हा येतो तेव्हा चांगले दस्तऐवजीकरण तयार करत नाही मुक्त सॉफ्टवेअर, मुक्त स्त्रोत विकसित करा किंवा इतर कोणत्याही प्रकारचे सॉफ्टवेअर, त्याच्या संभाव्य प्राप्तकर्त्यांना पाठविणे आहे (वापरकर्ते, प्रशासक, देखभालकर्ता किंवा अन्य विकसक) नकाशा किंवा होकायंत्रविना जंगलातून मार्ग शोधणे.

प्रत्येकासाठी चांगले दस्तऐवजीकरण तयार करा मुक्त सॉफ्टवेअर, मुक्त स्त्रोत तो देखील फायदेशीर आहे, जरी दस्तऐवजीकरण किंमत आहेजर गुंतवणूक योग्य प्रकारे केली गेली तर ती फायद्याची आहे. कारण, जग सॉफ्टवेअर बद्दल कथा पूर्ण आहे लेगसी कोड जुने किंवा सद्य प्रोग्रॅम, अ‍ॅप्लिकेशन्स किंवा सिस्टीम, ज्याला स्पर्श करण्याची हिंमत फक्त काही लोक करतात, कारण जवळजवळ कोणालाही समजत नाही. प्रोग्रामर कोड तयार करण्यावर आणि योग्यरित्या आणि संपूर्णपणे त्याचे दस्तऐवजीकरण न करण्यावर लक्ष केंद्रित करतात. आणि यावर उपाय करणे आवश्यक आहे.

README मजकूर फायलींमधील दस्तऐवजीकरणावर चांगल्या पद्धती

च्या बाबतीत विनामूल्य सॉफ्टवेअर आणि मुक्त स्त्रोत, दस्तऐवजीकरण बहुतेकदा मजकूर फायलींवर प्रतिबंधित असते, जेव्हा ते प्रोग्रामर किंवा समुदायांच्या लहान गटांद्वारे तयार केले जाते. परंतु, साधे वापरून साधे कागदपत्र तयार करेपर्यंत README.md मजकूर फाईल (किंवा .txt) आपण आपल्या घेऊ शकता सर्वोत्तम किंवा चांगल्या सराव, तृतीय पक्षांकडे जे तयार केले गेले आहे त्याबद्दल आवश्यक असलेली सर्वात संपूर्ण आणि तपशीलवार माहिती आणण्यासाठी टिपा किंवा निर्मितीचे उपयुक्त मार्गदर्शक.

आमच्या लेखासाठी, आम्ही घेतला आहे चांगले प्रथा द्वारे गर्भधारणा केली आणि उघड केली "विकास पुढाकाराचा कोड" अगोदर निर्देश केलेल्या बाबीसंबंधी बोलताना इंटर अमेरिकन डेव्हलपमेंट बँक, जे सारांश आम्हाला सांगते की a वर आधारित चांगले दस्तऐवजीकरण README.md मजकूर फाईल (किंवा .txt) याची रचना खालीलप्रमाणे करणे आवश्यक आहे:

README फाईल स्ट्रक्चरची शिफारस केली

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

ह्यात चांगल्या सराव, ते देखील जोडण्याची शिफारस करतात फाइल कागदपत्रे वाचा अधिक परिपूर्ण करण्यासाठी खालील विभागः

• कसे योगदान द्यावेः नवीन विकासकांना प्रकल्पांमध्ये योगदान देण्याची प्रक्रिया स्पष्ट करणारे विभाग.
• आचारसंहिता: आचारसंहितेचे स्पष्टीकरण करणारा विभाग डिजिटल टूल किंवा त्यांच्या समुदायासह कोणत्याही प्रकारे संवाद साधताना सामाजिक नियम, नियम आणि जबाबदा estab्या स्थापित करतो जे व्यक्ती आणि संस्थांनी पाळल्या पाहिजेत.
• बॅज: बॅजेस दर्शविणारा विभाग (README.md मध्ये एम्बेड केलेल्या छोट्या प्रतिमा) जे वाचनीय आणि संक्षिप्त मार्गाने टूलची स्थिती निर्दिष्ट करतात.
• आवृत्ती: डिजिटल टूलच्या आवृत्तीची सूची आणि प्रत्येक आवृत्तीत जोडलेली कार्यक्षमता सूचित करणारा विभाग.
• पावती: प्रोजेक्टमध्ये काही प्रमाणात योगदान देणार्‍या अन्य लोकांना किंवा संस्थांना पोचपावती समाविष्ट करणारा विभाग.

ही माहिती विस्तृत करण्यासाठी, वर चांगले प्रथा च्या बाबतीत दस्तऐवजीकरण च्या विकासासाठी फ्री सॉफ्टवेअर, द्वारे "विकास पुढाकाराचा कोड" अगोदर निर्देश केलेल्या बाबीसंबंधी बोलताना इंटर अमेरिकन डेव्हलपमेंट बँक आपण खालील दुव्यावर क्लिक करू शकता: दस्तऐवजीकरण - डिजिटल साधने प्रकाशित करण्यासाठी मार्गदर्शक. आणि इतर प्रकाशनांमध्ये आम्ही त्या भागाचा संदर्भ घेऊ चांगल्या सराव वर मूल्यमापन आणि परवाना अगोदर निर्देश केलेल्या बाबीसंबंधी बोलताना विनामूल्य आणि मुक्त सॉफ्टवेअर स्वत: ला.

निष्कर्ष

आम्ही आशा करतो की आहे "उपयुक्त छोटी पोस्ट" याबद्दल «Buenas prácticas» च्या क्षेत्रात «documentación» विकसित करताना तयार करणे «Software libre y abierto», सर्वांसाठी अत्यंत रुची आणि उपयुक्तता आहे «Comunidad de Software Libre y Código Abierto» आणि अनुप्रयोगांच्या अद्भुत, अवाढव्य आणि वाढत्या परिसंस्थेच्या प्रसारास मोठा वाटा आहे «GNU/Linux».

आणि अधिक माहितीसाठी, कधीही कोणालाही भेट देण्यास संकोच करू नका ऑनलाइन लायब्ररी कसे ओपनलिब्रा y जेडीआयटी वाचणे पुस्तके (पीडीएफ) या विषयावर किंवा इतरांवर ज्ञान क्षेत्र. आत्तासाठी, जर आपल्याला हे आवडले असेल «publicación», ते सामायिक करणे थांबवू नका आपल्यासह इतरांसह आवडत्या वेबसाइट, चॅनेल, गट किंवा समुदाय सामाजिक नेटवर्कचे, शक्यतो विनामूल्य आणि म्हणून मुक्त मॅस्टोडन, किंवा सुरक्षित आणि खाजगी सारखे तार.

किंवा आमच्या मुख्य पृष्ठास येथे भेट द्या DesdeLinux किंवा अधिकृत चॅनेलमध्ये सामील व्हा च्या टेलीग्राम DesdeLinux यावर किंवा इतर मनोरंजक प्रकाशने वाचण्यासाठी आणि त्यांना मत देण्यासाठी «Software Libre», «Código Abierto», «GNU/Linux» आणि संबंधित इतर विषय «Informática y la Computación», आणि «Actualidad tecnológica».