இலவச மற்றும் திறந்த மென்பொருளை உருவாக்க நல்ல நடைமுறைகள்: ஆவணம்

ஆவணம்: இலவச மற்றும் திறந்த மென்பொருளை உருவாக்க நல்ல நடைமுறைகள்

ஆவணம்: இலவச மற்றும் திறந்த மென்பொருளை உருவாக்க நல்ல நடைமுறைகள்

La ஆவணங்கள் மற்றும் ஒரு அடிப்படை பகுதியாக இருக்க வேண்டும் படைப்பு செயல்முறை மற்றும் திட்டமிடல் அனைத்து மனித செயல்பாடுகளிலும், மேலும் தொழில்நுட்ப துறையில், குறிப்பாக பகுதியில் மென்பொருள் மேம்பாடு.

El அனைத்து ஆவணங்களின் நோக்கம் அது அவராக இருக்க வேண்டும் மூன்றாம் தரப்பினருக்கு (பயனர்கள், நிர்வாகிகள், பராமரிப்பாளர்கள் அல்லது பிற டெவலப்பர்கள்) கற்பிக்கவும், பொதுவாக பழக்கமில்லாதவர்கள் தயாரிப்பு (குறியீடு, பயன்பாடு அல்லது அமைப்பு), இது எவ்வாறு உருவாக்கப்படுகிறது அதன் அமைப்பு, அதன் செயல்பாடு அது சாத்தியமானாலும் கூட, அதன் உருவாக்கத்திற்கான காரணம் மற்றும் வடிவமைப்பு மற்றும் செயல்பாட்டின் வழி.

நல்ல நடைமுறைகள்: ஆவணம் - அறிமுகம்

மேலும், குறிப்பிட்ட வழக்கில் இலவச மென்பொருள் ஆவணங்கள் மிக முக்கியமானவை, இது முழுமையாக உத்தரவாதம் அளிக்க அனுமதிக்கிறது என்பதால் அறிவு பரிமாற்றம் மற்றும் அதிகாரம் திருப்திகரமான பூர்த்தி செய்ய அவசியம் 4 சுதந்திரங்கள் அதை விளம்பரப்படுத்தியது, அவை:

  • 0: எந்தவொரு நோக்கத்திற்காகவும் நீங்கள் விரும்பினாலும் நிரலை இயக்குவதற்கான சுதந்திரம்.
  • 1: ஒரு திட்டத்தை அணுகவும் படிக்கவும், அதை உங்கள் சொந்த நலனுக்காக மாற்றவும் அல்லது மாற்றவும் சுதந்திரம்.
  • 2: அதே மற்றும் / அல்லது மற்றவர்களுக்கு உதவ நகல்களைப் பகிர அல்லது மறுபகிர்வு செய்வதற்கான சுதந்திரம்.
  • 3: உங்கள் மாற்றியமைக்கப்பட்ட பதிப்புகளின் நகல்களை மூன்றாம் தரப்பினருக்கு விநியோகிக்கும் சுதந்திரம்.

ஒரு நல்ல ஆவணங்கள் உருவாக்கப்பட்ட தயாரிப்பு சாத்தியமாக்குகிறது:

  • இது சரியாகப் பயன்படுத்தப்படுகிறது, மேலும் இது எளிதில் கற்பிக்கப்பட்டு கற்றுக்கொள்ளப்படுகிறது.
  • அதை மேம்படுத்த அல்லது மாற்றியமைக்க அதை மாற்ற விரும்புவோர் முழுமையாக புரிந்து கொள்ளுங்கள்.
  • சாத்தியமான அனைத்து அறிமுகமானவர்கள் மற்றும் அந்நியர்களிடையே, அதிக நம்பிக்கையுடன் பகிரப்பட்டு பெறவும்.
  • பொதுமக்கள் மத்தியில் ஒரு சிறந்த வெகுஜனத்தை வைத்திருங்கள்.

நல்ல நடைமுறைகள்: ஆவணம் - ரீட்மே

நல்ல நடைமுறைகள்: ஆவணம்

அடித்தளங்களை

வழக்கில் இலவச மென்பொருள் மற்றும் திறந்த மூலத்தின் வளர்ச்சி, பொதுவாக, ஆவணத்தின் முக்கிய பயனர்கள் தயாரிப்பு வடிவமைப்போடு தொடர்புடையது, அவை இருக்கும் அல்லது இருக்கும் பராமரிப்பு பொறுப்பு அதே. நல்ல அல்லது எந்த ஆவணமும் இல்லாமல், அதை நேரடியாக ஆராய்வது, அடைவது மட்டுமே சாத்தியமான மாற்று அதன் வடிவமைப்பு மற்றும் செயல்பாட்டைப் புரிந்து கொள்ளுங்கள்.

நல்ல ஆவணங்கள் வரும்போது அதை உருவாக்கவில்லை இலவச மென்பொருள், திறந்த மூலத்தை உருவாக்குங்கள் அல்லது வேறு எந்த வகையான மென்பொருளும், அதன் சாத்தியமான பெறுநர்களுக்கு அனுப்புவதாகும் (பயனர்கள், நிர்வாகிகள், பராமரிப்பாளர்கள் அல்லது பிற டெவலப்பர்கள்) வரைபடம் அல்லது திசைகாட்டி இல்லாமல் ஒரு காட்டில் ஒரு வழியைக் கண்டுபிடிக்க.

ஒவ்வொன்றிற்கும் நல்ல ஆவணங்களை உருவாக்கவும் இலவச மென்பொருள், திறந்த மூல இருப்பினும், இது நன்மை பயக்கும் ஆவணப்படுத்துவதற்கு ஒரு செலவு உள்ளதுமுதலீடு, சரியாக செய்தால், அது மதிப்புக்குரியது. ஏனெனில், உலகம் மென்பொருள் பற்றிய கதைகள் நிறைந்துள்ளது மரபு குறியீடுகள் பழைய அல்லது தற்போதைய நிரல்கள், பயன்பாடுகள் அல்லது அமைப்புகள், சிலர் மட்டுமே தொடத் துணிவதில்லை, ஏனென்றால் கிட்டத்தட்ட யாரும் புரிந்து கொள்ளவில்லை. புரோகிராமர்கள் குறியீட்டை உருவாக்குவதில் கவனம் செலுத்துகிறார்கள், அதை சரியாகவும் முழுமையாகவும் ஆவணப்படுத்தவில்லை. இதை சரிசெய்ய வேண்டும்.

README உரை கோப்புகளில் ஆவணப்படுத்தல் குறித்த நல்ல நடைமுறைகள்

வழக்கில் இலவச மென்பொருள் மற்றும் திறந்த மூல, ஆவணங்கள் பெரும்பாலும் உரை கோப்புகளுக்கு கட்டுப்படுத்தப்படுகின்றன, இது தனிநபர்கள் அல்லது புரோகிராமர்கள் அல்லது சமூகங்களின் சிறிய குழுக்களால் உருவாக்கப்படும் போது. ஆனால், ஒரு எளிய ஆவணத்தைப் உருவாக்கும் வரை உரை கோப்பு README.md (அல்லது .txt) நீங்கள் உங்களுடையது சிறந்த அல்லது நல்ல நடைமுறைகள், உருவாக்கப்பட்டவை பற்றிய மிக முழுமையான மற்றும் விரிவான தகவல்களை மூன்றாம் தரப்பினருக்கு எடுத்துச் செல்ல உதவிக்குறிப்புகள் அல்லது படைப்பின் பயனுள்ள வழிகாட்டி.

எங்கள் கட்டுரைக்கு, நாங்கள் எடுத்துள்ளோம் நல்ல நடைமுறைகள் கருத்தரிக்கப்பட்டு வெளிப்படுத்தப்பட்டது "மேம்பாட்டு முயற்சிகளுக்கான குறியீடு" தி இடை-அமெரிக்க அபிவிருத்தி வங்கி, சுருக்கமாக இது ஒரு நல்ல ஆவணத்தை அடிப்படையாகக் கொண்டது உரை கோப்பு README.md (அல்லது .txt) இது பின்வருமாறு கட்டமைக்கப்பட வேண்டும்:

பரிந்துரைக்கப்பட்ட README கோப்பு அமைப்பு

  • விளக்கம் மற்றும் சூழல்: செயல்பாடுகள், அது உருவாக்கப்பட்ட சூழல் மற்றும் அது தீர்க்க உதவும் வளர்ச்சி சிக்கல்களை நீங்கள் விவரிக்க வேண்டிய பிரிவு.
  • பயனரின் வழிகாட்டி: டிஜிட்டல் கருவியைப் பயன்படுத்தத் தொடங்குவது குறித்த இறுதி பயனருக்கு அறிவுறுத்தல்கள் குறிப்பிடப்பட வேண்டிய பிரிவு.
  • நிறுவல் வழிகாட்டி: டிஜிட்டல் கருவியை மீண்டும் பயன்படுத்த மற்றும் உள்ளமைக்க நிறுவல் வழிமுறைகள் குறிப்பிடப்பட வேண்டிய பிரிவு. இந்த பிரிவு டெவலப்பர்களுக்காக வடிவமைக்கப்பட்டுள்ளது.
  • ஆசிரியர்கள் கருவியின் கூட்டுப்பணியாளர்களுக்கு வரவுகளை வழங்க வேண்டிய பிரிவு.
  • கருவி குறியீட்டிற்கான உரிமம்: டிஜிட்டல் கருவியை மீண்டும் பயன்படுத்த மூன்றாம் தரப்பினருக்கு அனுமதிக்கப்பட்ட பிரிவு குறிப்பிடப்பட வேண்டும்.
  • கருவியின் ஆவணமாக்கலுக்கான உரிமம்: உருவாக்கப்பட்ட ஆவணங்களில் உள்ள உரிமத்தின் வகை குறிப்பிடப்பட வேண்டும்.

இவற்றில் நல்ல நடைமுறைகள், அவர்கள் சேர்க்க பரிந்துரைக்கின்றனர் README கோப்பு ஆவணங்கள் அதை முழுமையாக முடிக்க, பின்வரும் பிரிவுகள்:

  • பங்களிப்பது எப்படி: புதிய டெவலப்பர்களுக்கு திட்டங்களுக்கு பங்களிக்கும் செயல்முறையை விளக்கும் பிரிவு.
  • நடத்தை விதி: நடத்தை நெறியை விளக்கும் பிரிவு டிஜிட்டல் கருவி அல்லது அவர்களின் சமூகத்துடன் எந்த வகையிலும் தொடர்பு கொள்ளும்போது தனிநபர்கள் மற்றும் நிறுவனங்கள் பின்பற்ற வேண்டிய சமூக விதிமுறைகள், விதிகள் மற்றும் பொறுப்புகளை நிறுவுகிறது.
  • பேட்ஜ்கள்: கருவியின் நிலையை படிக்கக்கூடிய மற்றும் சுருக்கமான முறையில் குறிப்பிடும் பேட்ஜ்களை (README.md இல் உட்பொதிக்கப்பட்ட சிறிய படங்கள்) காட்டும் பிரிவு.
  • பதிப்பு: டிஜிட்டல் கருவியின் பதிப்புகள் மற்றும் ஒவ்வொரு பதிப்பிலும் சேர்க்கப்பட்ட செயல்பாடுகளின் பட்டியலைக் குறிக்கும் பிரிவு.
  • ஒப்புதல்கள்: திட்டத்திற்கு ஏதேனும் ஒரு வழியில் பங்களித்த பிற நபர்கள் அல்லது நிறுவனங்களுக்கான ஒப்புதல்களைக் கொண்ட பிரிவு.

இந்த தகவலை விரிவாக்க, இல் நல்ல நடைமுறைகள் விஷயங்களில் ஆவணங்கள் வளர்ச்சிக்கு இலவச மென்பொருள், மூலம் "மேம்பாட்டு முயற்சிகளுக்கான குறியீடு" தி இடை-அமெரிக்க அபிவிருத்தி வங்கி பின்வரும் இணைப்பைக் கிளிக் செய்யலாம்: ஆவணம் - டிஜிட்டல் கருவிகளை வெளியிடுவதற்கான வழிகாட்டி. மற்ற வெளியீடுகளில் நாம் குறிப்பிடும் பகுதியை ஆராய்வோம் நல்ல நடைமுறைகள் அன்று மதிப்பீடு மற்றும் உரிமம் தி இலவச மற்றும் திறந்த மென்பொருள் தங்களை.

முடிவுக்கு

முடிவுக்கு

நாங்கள் நம்புகிறோம் ESTA "பயனுள்ள சிறிய இடுகை" மீது «Buenas prácticas» இந்த துறையில் «documentación» வளரும் போது உருவாக்க «Software libre y abierto», முழு ஆர்வமும் பயன்பாடும் இருக்கும் «Comunidad de Software Libre y Código Abierto» மற்றும் பயன்பாடுகளின் அற்புதமான, பிரம்மாண்டமான மற்றும் வளர்ந்து வரும் சுற்றுச்சூழல் அமைப்பின் பரவலுக்கு பெரும் பங்களிப்பு «GNU/Linux».

மேலும் தகவலுக்கு, எதையும் பார்வையிட எப்போதும் தயங்க வேண்டாம் ஆன்லைன் நூலகம் போன்ற OpenLibra y ஜெடிஐடி வாசிப்பதற்கு புத்தகங்கள் (PDF கள்) இந்த தலைப்பில் அல்லது பிறவற்றில் அறிவு பகுதிகள். இப்போதைக்கு, நீங்கள் இதை விரும்பினால் «publicación», பகிர்வதை நிறுத்த வேண்டாம் மற்றவர்களுடன், உங்களுடையது பிடித்த வலைத்தளங்கள், சேனல்கள், குழுக்கள் அல்லது சமூகங்கள் சமூக வலைப்பின்னல்களில், முன்னுரிமை இலவசம் மற்றும் திறந்திருக்கும் மாஸ்டாடோன், அல்லது பாதுகாப்பான மற்றும் தனிப்பட்ட போன்றவை தந்தி.

அல்லது எங்கள் முகப்புப் பக்கத்தைப் பார்வையிடவும் FromLinux அல்லது அதிகாரப்பூர்வ சேனலில் சேரவும் FromLinux இலிருந்து தந்தி இந்த அல்லது பிற சுவாரஸ்யமான வெளியீடுகளைப் படித்து வாக்களிக்க «Software Libre», «Código Abierto», «GNU/Linux» மற்றும் பிற தலைப்புகள் «Informática y la Computación», மற்றும் «Actualidad tecnológica».


கட்டுரையின் உள்ளடக்கம் எங்கள் கொள்கைகளை பின்பற்றுகிறது தலையங்க நெறிமுறைகள். பிழையைப் புகாரளிக்க கிளிக் செய்க இங்கே.

கருத்து தெரிவிப்பதில் முதலில் இருங்கள்

உங்கள் கருத்தை தெரிவிக்கவும்

உங்கள் மின்னஞ்சல் முகவரி வெளியிடப்பட்ட முடியாது.

*

*

  1. தரவுக்கு பொறுப்பு: மிகுவல் ஏஞ்சல் கேடன்
  2. தரவின் நோக்கம்: கட்டுப்பாட்டு ஸ்பேம், கருத்து மேலாண்மை.
  3. சட்டபூர்வமாக்கல்: உங்கள் ஒப்புதல்
  4. தரவின் தொடர்பு: சட்டபூர்வமான கடமையால் தவிர மூன்றாம் தரப்பினருக்கு தரவு தெரிவிக்கப்படாது.
  5. தரவு சேமிப்பு: ஆக்சென்டஸ் நெட்வொர்க்குகள் (EU) வழங்கிய தரவுத்தளம்
  6. உரிமைகள்: எந்த நேரத்திலும் உங்கள் தகவல்களை நீங்கள் கட்டுப்படுத்தலாம், மீட்டெடுக்கலாம் மற்றும் நீக்கலாம்.