મફત અને ખુલ્લા સ Softwareફ્ટવેર વિકસાવવા માટે સારી પ્રથાઓ: દસ્તાવેજીકરણ

La દસ્તાવેજીકરણ એક મૂળભૂત ભાગ છે અને હોવો જોઈએ સર્જનાત્મક પ્રક્રિયા અને આયોજન તમામ માનવીય પ્રવૃત્તિઓ, અને તકનીકી ક્ષેત્રમાં વધુ, ખાસ કરીને ક્ષેત્રમાં સોફ્ટવેર વિકાસ.

El બધા દસ્તાવેજો હેતુ તે તેને જ હોવું જોઈએ તૃતીય પક્ષો (વપરાશકર્તાઓ, સંચાલકો, જાળવણીકારો અથવા અન્ય વિકાસકર્તાઓ) શીખવો, જે સામાન્ય રીતે પરિચિત નથી ઉત્પાદન (કોડ, એપ્લિકેશન અથવા સિસ્ટમ), તે કેવી રીતે બનાવવામાં આવે છે તેની રચના, તેનું સંચાલન અને શક્ય હોય તો પણ, તેની બનાવટનું કારણ અને તેની ડિઝાઇન અને operationપરેશનની રીત.

વળી, ના ચોક્કસ કિસ્સામાં મફત સ Softwareફ્ટવેર દસ્તાવેજીકરણ મહત્વપૂર્ણ છે, કારણ કે તે સંપૂર્ણ રૂપે ખાતરી આપી શકે છે જ્ knowledgeાન સ્થાનાંતરણ અને સશક્તિકરણ ની સંતોષકારક પરિપૂર્ણતા માટે જરૂરી 4 સ્વતંત્રતાઓ તેના દ્વારા પ્રોત્સાહન, જે આ છે:

• 0: જો તમે ઇચ્છો તો પ્રોગ્રામ ચલાવવાની સ્વતંત્રતા, કોઈપણ હેતુ માટે.
• 1: કોઈ પ્રોગ્રામ accessક્સેસ કરવાની અને તેનો અભ્યાસ કરવાની અને તેને તમારા પોતાના ફાયદા માટે બદલી અથવા અનુકૂળ કરવાની સ્વતંત્રતા.
• 2: સમાન ફેલાવવા અને / અથવા અન્ય લોકોને મદદ કરવા માટે નકલો વહેંચવાની અથવા ફરીથી વહેંચવાની સ્વતંત્રતા.
• 3: તમારા સુધારેલા સંસ્કરણોની નકલો તૃતીય પક્ષોને વિતરિત કરવાની સ્વતંત્રતા.

એક સારા દસ્તાવેજીકરણ શક્ય બનાવે છે, તેથી, બનાવેલ ઉત્પાદન:

• તેનો ઉપયોગ યોગ્ય રીતે કરવામાં આવે છે, અને તે વધુ સરળતાથી શીખવવામાં આવે છે અને શીખી શકાય છે.
• જેઓ તેને સુધારવા અથવા અનુકૂલન કરવા માટે તેને સંશોધિત કરવા માંગે છે તે લોકો દ્વારા સંપૂર્ણ રીતે સમજો.
• બધા સંભવિત પરિચિતો અને અજાણ્યાઓમાં, વધુ આત્મવિશ્વાસ સાથે વહેંચો અને પ્રાપ્ત થાઓ.
• લોકોમાં વધુ સારી સમૂહ રાખો.

સારી પ્રથાઓ: દસ્તાવેજીકરણ

ફંડામેન્ટલ્સ

ના કિસ્સામાં મફત સ Softwareફ્ટવેર અને ખુલ્લા સ્રોતનો વિકાસ, સામાન્ય રીતે, દસ્તાવેજો મુખ્ય વપરાશકર્તાઓ ઉત્પાદન ડિઝાઇનને સંબંધિત, તે છે જે હશે અથવા હશે, છે જાળવણી માટે જવાબદાર એ જ. અને સારા અથવા કોઈ દસ્તાવેજ વિના, તેનો એકમાત્ર વ્યવહારુ વિકલ્પ તે સીધો અન્વેષણ કરે છે, તે પ્રાપ્ત કરે છે તેની ડિઝાઇન અને કાર્યને સમજો.

જ્યારે વાત આવે ત્યારે સારા દસ્તાવેજો બનાવતા નથી ફ્રી સ Softwareફ્ટવેર, ઓપન સોર્સ વિકસિત કરો અથવા કોઈપણ અન્ય પ્રકારનું સ softwareફ્ટવેર, તેના સંભવિત પ્રાપ્તિકર્તાઓને મોકલવાનું છે (વપરાશકર્તાઓ, સંચાલકો, જાળવણીકારો અથવા અન્ય વિકાસકર્તાઓ) નકશા અથવા હોકાયંત્ર વિના જંગલમાંથી રસ્તો શોધવા માટે.

દરેક માટે સારા દસ્તાવેજો બનાવો મફત સ Softwareફ્ટવેર, ઓપન સોર્સ તે ફાયદાકારક પણ છે, કારણ કે દસ્તાવેજીકરણની કિંમત છેજો રોકાણ યોગ્ય રીતે કરવામાં આવે તો તે યોગ્ય છે. કારણ કે, ની દુનિયા સોફ્ટવેર વિશેની વાર્તાઓથી ભરેલી છે વારસો કોડ જૂના અથવા વર્તમાન પ્રોગ્રામ્સ, એપ્લિકેશન અથવા સિસ્ટમો, જે ફક્ત થોડા લોકો જ સ્પર્શ કરવાની હિંમત કરે છે, કારણ કે લગભગ કોઈ સમજી શકતું નથી. પ્રોગ્રામરો કોડ બનાવવા અને તેના યોગ્ય અને સંપૂર્ણ દસ્તાવેજીકરણ નહીં કરવા પર ધ્યાન કેન્દ્રિત કરે છે. અને આ ઉપાય કરવો જ જોઇએ.

README ટેક્સ્ટ ફાઇલોમાં દસ્તાવેજીકરણ માટેની સારી પ્રથાઓ

ના કિસ્સામાં મફત સ Softwareફ્ટવેર અને ખુલ્લા સ્રોત, દસ્તાવેજીકરણ હંમેશાં ટેક્સ્ટ ફાઇલો પર પ્રતિબંધિત હોય છે, જ્યારે તે પ્રોગ્રામર્સ અથવા સમુદાયોના વ્યક્તિઓ અથવા નાના જૂથો દ્વારા બનાવવામાં આવે છે. પરંતુ, સરળનો ઉપયોગ કરીને સરળ દસ્તાવેજીકરણ બનાવતા સુધી README.md (અથવા .txt) ટેક્સ્ટ ફાઇલ તમે તમારી કરી શકો છો શ્રેષ્ઠ અથવા સારી વ્યવહાર, તૃતીય પક્ષોને જે બનાવવામાં આવ્યું છે તેના વિશે જરૂરી સૌથી સંપૂર્ણ અને વિગતવાર માહિતી લાવવા માટે ટીપ્સ અથવા બનાવટની ઉપયોગી માર્ગદર્શિકા.

અમારા લેખ માટે, અમે લીધો છે સારા સિદ્ધાંતો દ્વારા કલ્પના અને જાહેર "વિકાસ પહેલ માટેનો કોડ" આ ઇન્ટર-અમેરિકન ડેવલપમેન્ટ બેન્ક, જે સારાંશ જણાવે છે કે a પર આધારિત સારા દસ્તાવેજો README.md (અથવા .txt) ટેક્સ્ટ ફાઇલ તે નીચે મુજબ રચાયેલ હોવું જ જોઈએ:

README ફાઇલ સ્ટ્રક્ચરની ભલામણ કરી

• વર્ણન અને સંદર્ભ: વિભાગ જ્યાં તમારે કાર્યોને વર્ણવવું આવશ્યક છે, સંદર્ભ કે જ્યાં તેને વિકસાવવામાં આવ્યો હતો અને વિકાસની સમસ્યાઓ જે તેને હલ કરવામાં મદદ કરે છે.
• વપરાશકર્તા માર્ગદર્શિકા: વિભાગ જ્યાં અંતિમ વપરાશકર્તાને ડિજિટલ ટૂલનો ઉપયોગ કેવી રીતે કરવો તે અંગેના સૂચનોનો ઉલ્લેખ કરવો જોઈએ.
• સ્થાપન માર્ગદર્શિકા: વિભાગ જ્યાં ડિજિટલ ટૂલનો ફરીથી ઉપયોગ અને ગોઠવણી માટેના ઇન્સ્ટોલેશન સૂચનોનો ઉલ્લેખ કરવો જોઇએ. આ વિભાગ વિકાસકર્તાઓ માટે બનાવાયેલ છે.
• લેખકો વિભાગ જ્યાં ક્રેડિટ ટૂલના સહયોગીઓને આપવી આવશ્યક છે.
• ટૂલ કોડ માટેનું લાઇસન્સ: વિભાગ જ્યાં ડિજિટલ ટૂલના ફરીથી ઉપયોગ માટે તૃતીય પક્ષોને આપવામાં આવેલી મંજૂરીઓ સ્પષ્ટ કરવી આવશ્યક છે.
• ટૂલ દસ્તાવેજીકરણ માટે લાઇસન્સ: બનાવેલા દસ્તાવેજોમાં સમાવિષ્ટ લાઇસન્સના પ્રકારનો ઉલ્લેખ કરવો આવશ્યક છે.

આમાં સારા સિદ્ધાંતો, તેઓ પણ ઉમેરવાની ભલામણ કરે છે ફાઇલ દસ્તાવેજો ફરીથી વાંચો તેને વધુ સંપૂર્ણ બનાવવા માટે, નીચેના વિભાગો:

• કેવી રીતે ફાળો આપવો: વિભાગ કે જે નવા વિકાસકર્તાઓને પ્રોજેક્ટ્સમાં ફાળો આપવાની પ્રક્રિયા સમજાવે છે.
• આચાર સંહિતા: વિભાગ કે જે આચારસંહિતાને સમજાવે છે તે ડિજિટલ ટૂલ અથવા તેમના સમુદાય સાથે કોઈપણ રીતે વાતચીત કરતી વખતે સામાજિક ધોરણો, નિયમો અને જવાબદારીઓ સ્થાપિત કરે છે કે જે વ્યક્તિઓ અને સંસ્થાઓએ અનુસરવા જોઈએ.
• બેજેસ: વિભાગ કે જે બેજેસ (README.md માં એમ્બેડ કરેલી નાની છબીઓ) બતાવે છે જે ટૂલની સ્થિતિને વાંચનીય અને સંક્ષિપ્ત રીતે સ્પષ્ટ કરે છે.
• સંસ્કરણ: વિભાગ કે જે ડિજિટલ ટૂલના સંસ્કરણોની સૂચિ અને દરેક સંસ્કરણમાં ઉમેરવામાં આવેલી કાર્યોને સૂચવે છે.
• સ્વીકૃતિઓ: આ વિભાગ કે જેમાં અન્ય લોકો અથવા સંસ્થાઓને સ્વીકૃતિ છે જેણે પ્રોજેક્ટમાં કોઈ રીતે ફાળો આપ્યો છે.

આ માહિતીને વિસ્તૃત કરવા માટે, પર સારા સિદ્ધાંતો ની બાબતોમાં દસ્તાવેજીકરણ ના વિકાસ માટે ફ્રી સૉફ્ટવેર, દ્વારા "વિકાસ પહેલ માટેનો કોડ" આ ઇન્ટર-અમેરિકન ડેવલપમેન્ટ બેન્ક તમે નીચેની લિંક પર ક્લિક કરી શકો છો: દસ્તાવેજીકરણ - ડિજિટલ ટૂલ્સ પ્રકાશિત કરવા માટેની માર્ગદર્શિકા. અને અન્ય પ્રકાશનોમાં આપણે તેનો ઉલ્લેખ કરતા ભાગની શોધ કરીશું સારા સિદ્ધાંતો આ વિશે મૂલ્યાંકન અને લાઇસન્સિંગ આ મફત અને ખુલ્લા સ Softwareફ્ટવેર પોતાને.

નિષ્કર્ષ

અમે આશા રાખીએ છીએ કે છે "મદદરૂપ થોડી પોસ્ટ" વિશે «Buenas prácticas» ક્ષેત્રમાં «documentación» વિકાસ કરતી વખતે બનાવવી «Software libre y abierto», સંપૂર્ણ રૂચિ અને ઉપયોગીતા બનો «Comunidad de Software Libre y Código Abierto» અને તે માટેના અને એપ્લિકેશનના અદ્ભુત, વિશાળ અને વધતા જતા ઇકોસિસ્ટમના પ્રસરણમાં મોટો ફાળો «GNU/Linux».

અને વધુ માહિતી માટે, હંમેશાં કોઈની મુલાકાત લેવામાં અચકાશો નહીં ઓનલાઇન લાઇબ્રેરી કોમોના ઓપનલીબ્રા y જેડીઆઈટી વાંચવા માટે પુસ્તકો (પીડીએફ) આ મુદ્દા પર અથવા અન્ય જ્ knowledgeાન ક્ષેત્રો. હમણાં માટે, જો તમને આ ગમ્યું હોય «publicación», તેને શેર કરવાનું બંધ ન કરો અન્ય સાથે, તમારામાં પ્રિય વેબસાઇટ્સ, ચેનલો, જૂથો અથવા સમુદાયો સામાજિક નેટવર્ક્સના, પ્રાધાન્ય મફત અને જેમ કે ખુલ્લા મસ્તોડન, અથવા સુરક્ષિત અને ખાનગી જેવી Telegram.

અથવા ખાલી અમારા હોમ પેજની મુલાકાત લો DesdeLinux અથવા Channelફિશિયલ ચેનલમાં જોડાઓ ના ટેલિગ્રામ DesdeLinux આ અથવા અન્ય રસપ્રદ પ્રકાશનો વાંચવા અને તેને મત આપવા માટે «Software Libre», «Código Abierto», «GNU/Linux» અને સંબંધિત અન્ય વિષયો «Informática y la Computación», અને «Actualidad tecnológica».