বিনামূল্যে এবং ওপেন সফ্টওয়্যার বিকাশ করার জন্য ভাল অভ্যাস: ডকুমেন্টেশন

La ডকুমেন্টেশন এর একটি মৌলিক অংশ এবং হওয়া উচিত সৃজনশীল প্রক্রিয়া এবং পরিকল্পনা সমস্ত মানবিক ক্রিয়াকলাপ, এবং প্রযুক্তিগত ক্ষেত্রে বিশেষত এর অঞ্চলে of সফটওয়্যার উন্নয়ন.

El সমস্ত নথির উদ্দেশ্য এটা অবশ্যই তাঁরই হবে তৃতীয় পক্ষগুলি (ব্যবহারকারী, প্রশাসক, রক্ষণাবেক্ষণকারী বা অন্যান্য বিকাশকারী) শেখান, যারা সাধারণত পরিচিত হয় না পণ্য (কোড, অ্যাপ্লিকেশন বা সিস্টেম)কিভাবে এটি তৈরি করা হয় এটির কাঠামো, এটির অপারেশন এমনকি যদি সম্ভব হয় তবে এটির তৈরির কারণ এবং এটির নকশা ও পরিচালনা পদ্ধতি

তদ্ব্যতীত, নির্দিষ্ট ক্ষেত্রে বিনামূল্যে সফ্টওয়্যার ডকুমেন্টেশন জরুরী, যেহেতু এটি সম্পূর্ণরূপে গ্যারান্টি দেয় allows জ্ঞান স্থানান্তর এবং ক্ষমতায়ন সন্তোষজনক পরিপূরণ জন্য প্রয়োজনীয় 4 স্বাধীনতা এটি দ্বারা প্রচারিত, যা হ'ল:

• 0: আপনি যেভাবে চান প্রোগ্রামটি চালানোর স্বাধীনতা।
• 1: কোনও প্রোগ্রাম অ্যাক্সেস এবং অধ্যয়ন করার স্বাধীনতা এবং এটি আপনার নিজের সুবিধার জন্য পরিবর্তন বা মানিয়ে নিতে।
• 2: একইগুলি ছড়িয়ে দিতে এবং / অথবা অন্যকে সহায়তা করার জন্য অনুলিপিগুলি ভাগ বা ভাগ করার স্বাধীনতা।
• 3: আপনার পরিবর্তিত সংস্করণগুলির অনুলিপি তৃতীয় পক্ষগুলিতে বিতরণ করার স্বাধীনতা।

একটি ভাল ডকুমেন্টেশন তৈরি করা পণ্যটিকে, তাই এটি সম্ভব করে তোলে:

• এটি সঠিকভাবে ব্যবহৃত হয়, এবং এটি আরও সহজে শেখানো এবং শেখানো হয়।
• যারা এটির উন্নতি বা মানিয়ে নিতে এটি পরিবর্তন করতে চান তাদের পুঙ্খানুপুঙ্খভাবে বুঝতে পারেন।
• সমস্ত সম্ভাব্য পরিচিত এবং অপরিচিতর মধ্যে, আরও আত্মবিশ্বাসের সাথে ভাগ হয়ে উঠুন এবং গ্রহণ করুন।
• জনগণের মধ্যে আরও ভাল ভরসা রাখুন।

ভাল অভ্যাস: ডকুমেন্টেশন

ফান্ডামেন্টোস

এর ক্ষেত্রে ফ্রি সফটওয়্যার এবং ওপেন সোর্স এর বিকাশ, সাধারণত, ডকুমেন্টেশন প্রধান ব্যবহারকারী পণ্য নকশার তুলনায়, যা সেগুলি হবে বা হবে, সেগুলি রক্ষণাবেক্ষণের জন্য দায়ী একই. এবং ভাল বা কোনও ডকুমেন্টেশন ছাড়াই একমাত্র কার্যকর বিকল্প হ'ল সরাসরি এটি অন্বেষণ করা, অর্জন করা এর নকশা এবং ফাংশন বুঝতে.

এটি আসে যখন ভাল ডকুমেন্টেশন তৈরি না মুক্ত সফটওয়্যার, ওপেন সোর্স বিকাশ করুন বা অন্য কোনও ধরণের সফ্টওয়্যার হ'ল তার সম্ভাব্য প্রাপকদের কাছে প্রেরণ করা (ব্যবহারকারী, প্রশাসক, রক্ষণাবেক্ষণকারী বা অন্যান্য বিকাশকারী) কোনও মানচিত্র বা কম্পাস ছাড়াই জঙ্গলের মধ্য দিয়ে কোনও পথ সন্ধান করতে।

প্রতিটি জন্য ভাল ডকুমেন্টেশন তৈরি করুন ফ্রি সফটওয়্যার, ওপেন সোর্স যদিও এটি উপকারী, যদিও ডকুমেন্টিংয়ের একটি খরচ আছেবিনিয়োগটি যদি সঠিকভাবে করা হয় তবে তা মূল্যবান। কারণ, বিশ্ব সফটওয়্যার গল্পে পূর্ণ উত্তরাধিকার কোডগুলি পুরানো বা বর্তমান প্রোগ্রাম, অ্যাপ্লিকেশন বা সিস্টেম, যা খুব কম লোকই স্পর্শ করার সাহস করে, কারণ প্রায় কেউই বুঝতে পারে না। প্রোগ্রামাররা কোড তৈরি করতে এবং সঠিকভাবে এবং সম্পূর্ণরূপে এটি ডকুমেন্টিং না করার দিকে মনোনিবেশ করে। এবং এটি প্রতিকার করা আবশ্যক।

README পাঠ্য ফাইলগুলিতে ডকুমেন্টেশনে ভাল অনুশীলন

এর ক্ষেত্রে ফ্রি সফটওয়্যার এবং ওপেন সোর্স, ডকুমেন্টেশনটি পাঠ্য ফাইলগুলিতে প্রায়শই সীমাবদ্ধ থাকে যখন এটি ব্যক্তি বা প্রোগ্রামার বা সম্প্রদায়গুলির ছোট দল দ্বারা তৈরি করা হয়। এমনকি, এমনকি একটি সাধারণ ব্যবহার করে একটি সাধারণ ডকুমেন্টেশন তৈরি করা README.md (বা .txt) পাঠ্য ফাইল আপনি আপনার করতে পারেন সেরা বা ভাল অনুশীলন, তৃতীয় পক্ষগুলিতে কী তৈরি হয়েছে তা সম্পর্কে প্রয়োজনীয় সবচেয়ে সম্পূর্ণ এবং বিস্তারিত তথ্য আনতে টিপস বা সৃষ্টির দরকারী গাইড।

আমাদের নিবন্ধের জন্য, আমরা গ্রহণ করেছি ভাল অভ্যাস দ্বারা কল্পনা এবং প্রকাশিত "উন্নয়ন উদ্যোগের জন্য কোড ia" এর ইন্টার-আমেরিকান ডেভেলপমেন্ট ব্যাংক, যা সংক্ষেপে আমাদেরকে বলে যে ভাল ডকুমেন্টেশন a এর উপর ভিত্তি করে README.md (বা .txt) পাঠ্য ফাইল এটি অবশ্যই নিম্নলিখিত হিসাবে কাঠামোযুক্ত হতে হবে:

প্রস্তাবিত README ফাইল কাঠামো

• বর্ণনা এবং প্রসঙ্গ: কার্যকারিতাটি যে বিভাগে বিকাশ করা উচিত, সেই বিভাগটি যেখানে এটি বিকশিত হয়েছিল এবং বিকাশ সমস্যার সমাধান করতে সহায়তা করেছে Section
• ব্যবহার বিধি: যে বিভাগে শেষ ব্যবহারকারীকে কীভাবে ডিজিটাল সরঞ্জাম ব্যবহার শুরু করবেন সে সম্পর্কে নির্দেশাবলীর উল্লেখ করা উচিত।
• ইনস্টলেশন গাইড: ডিজিটাল সরঞ্জামটি পুনরায় ব্যবহার এবং কনফিগার করার জন্য ইনস্টলেশন নির্দেশাবলী উল্লেখ করা উচিত। এই বিভাগটি বিকাশকারীদের জন্য তৈরি।
• লেখক বিভাগটির যেখানে ক্রেডিট অবশ্যই সরঞ্জামের সহযোগীদের দেওয়া উচিত।
• সরঞ্জাম কোডের জন্য লাইসেন্স: যে বিভাগে তৃতীয় পক্ষগুলিকে ডিজিটাল সরঞ্জাম পুনরায় ব্যবহারের জন্য অনুমোদিত অনুমতিগুলি নির্দিষ্ট করতে হবে be
• সরঞ্জাম নথির জন্য লাইসেন্স: যে বিভাগটি তৈরি করা ডকুমেন্টেশনে অন্তর্ভুক্ত লাইসেন্সের ধরণের উল্লেখ করা উচিত Section

এই মধ্যে ভাল অভ্যাস, তারা এছাড়াও যোগ করার পরামর্শ দেয় পুনরায় ফাইল ডকুমেন্টেশন এটি আরও সম্পূর্ণ করার জন্য, নিম্নলিখিত বিভাগগুলি:

• কীভাবে অবদান রাখবেন: নতুন বিকাশকারীদের প্রকল্পগুলিতে অবদান রাখার প্রক্রিয়াটি ব্যাখ্যা করে এমন বিভাগ।
• আচরণ বিধি: আচরণ বিভাগের ব্যাখ্যা করে এমন বিভাগটি ডিজিটাল সরঞ্জাম বা তাদের সম্প্রদায়ের সাথে যে কোনও উপায়ে ইন্টারেক্ট করার সময় ব্যক্তি ও সংস্থাগুলিকে অবশ্যই অনুসরণ করা সামাজিক রীতিনীতি, বিধি ও দায়িত্ব প্রতিষ্ঠিত করে।
• ব্যাজগুলি: ব্যাজগুলি দেখানো বিভাগ (README.md- এ এমবেড করা ছোট চিত্রগুলি) যা একটি পঠনযোগ্য এবং সংক্ষিপ্ত উপায়ে টুলের অবস্থা নির্দিষ্ট করে।
• সংস্করণ: বিভাগ যা ডিজিটাল সরঞ্জামের সংস্করণগুলির তালিকা এবং প্রতিটি সংস্করণে যুক্ত কার্যকারিতা নির্দেশ করে।
• স্বীকৃতি: প্রকল্পে কোনওভাবে অবদান রেখেছে এমন অন্যান্য ব্যক্তি বা সংস্থাগুলির স্বীকৃতি রয়েছে এমন বিভাগে।

এই তথ্যটি প্রসারিত করতে ভাল অভ্যাস বিষয়ে ডকুমেন্টেশন উন্নয়নের জন্য ফ্রি সফটওয়্যার, দ্বারা "উন্নয়ন উদ্যোগের জন্য কোড ia" এর ইন্টার-আমেরিকান ডেভেলপমেন্ট ব্যাংক আপনি নিম্নলিখিত লিঙ্কে ক্লিক করতে পারেন: ডকুমেন্টেশন - ডিজিটাল সরঞ্জাম প্রকাশের জন্য গাইড। এবং অন্যান্য প্রকাশনাগুলিতে আমরা অংশটি উল্লেখ করে অন্বেষণ করব ভাল অভ্যাস সম্পর্কে মূল্যায়ন এবং লাইসেন্সিং এর বিনামূল্যে এবং ওপেন সফ্টওয়্যার নিজেদের.

উপসংহার

আমরা আশা করি যে Esta "দরকারী ছোট পোস্ট" সম্পর্কে «Buenas prácticas» ক্ষেত্রে «documentación» বিকাশ যখন তৈরি করা «Software libre y abierto», সম্পূর্ণ আগ্রহী এবং উপযোগী হতে হবে «Comunidad de Software Libre y Código Abierto» এবং অ্যাপ্লিকেশনগুলির জন্য এবং এর অপূর্ব, বিশাল এবং বর্ধমান বাস্তুতন্ত্রের বিস্তারে দুর্দান্ত অবদান «GNU/Linux».

এবং আরও তথ্যের জন্য, সর্বদা কোনও দেখার জন্য দ্বিধা করবেন না অনলাইন লাইব্রেরি Como OpenLibra y জেডিআইটি পড়তে বই (পিডিএফ) এই বিষয় বা অন্যদের উপর জ্ঞান অঞ্চল। আপাতত, যদি আপনি এটি পছন্দ করেন «publicación», এটি ভাগ করা বন্ধ করবেন না অন্যদের সাথে, আপনার মধ্যে প্রিয় ওয়েবসাইট, চ্যানেল, গোষ্ঠী বা সম্প্রদায়গুলি সামাজিক নেটওয়ার্কগুলির, পছন্দমতো বিনামূল্যে এবং হিসাবে খোলা প্রস্তরীভূত হাতী, বা সুরক্ষিত এবং ব্যক্তিগত পছন্দ Telegram.

বা কেবল আমাদের হোম পৃষ্ঠাতে এ যান DesdeLinux অথবা অফিসিয়াল চ্যানেলে যোগদান করুন এর টেলিগ্রাম DesdeLinux এই বা অন্যান্য আকর্ষণীয় প্রকাশনা পড়তে এবং ভোট দিতে «Software Libre», «Código Abierto», «GNU/Linux» এবং সম্পর্কিত অন্যান্য বিষয় «Informática y la Computación», এবং «Actualidad tecnológica».