روشهای خوب برای توسعه نرم افزار آزاد و آزاد: مستندات

مستندات: اقدامات خوب برای توسعه نرم افزار آزاد و آزاد

مستندات: اقدامات خوب برای توسعه نرم افزار آزاد و آزاد

La مستندات است و باید یک قسمت اساسی از روند خلاق و برنامه ریزی از همه فعالیتهای انسانی ، و بیشتر در زمینه فن آوری ، به ویژه در منطقه توسعه نرم افزار.

El هدف از تمام اسناد و مدارک باید او باشد آموزش اشخاص ثالث (کاربران ، سرپرستان ، نگهدارندگان یا سایر توسعه دهندگان)، که معمولاً با محصول (کد ، برنامه یا سیستم)، چگونه ایجاد می شود ساختار آن ، عملکرد آن و حتی در صورت امکان ، دلیل ایجاد آن و نحوه طراحی و عملکرد آن.

روشهای خوب: مستندات - مقدمه

علاوه بر این ، در مورد خاص از مستندات نرم افزار رایگان بسیار حیاتی است، از آنجا که اجازه می دهد تا به طور کامل تضمین می کند انتقال دانش و توانمند سازی برای تحقق رضایت بخش از 4 آزادی تبلیغ شده توسط آن ، که عبارتند از:

  • 0: آزادی اجرای برنامه به هر دلخواه که بخواهید ، برای هر هدفی.
  • 1: آزادی دسترسی و مطالعه یک برنامه ، و تغییر یا تطبیق آن برای منافع خود.
  • 2: آزادی به اشتراک گذاری یا توزیع مجدد نسخه ها برای انتشار نسخه های مشابه و / یا کمک به دیگران.
  • 3: آزادی توزیع نسخه های اصلاح شده شما به اشخاص ثالث.

یک مستند خوب این امکان را ایجاد می کند که محصول ایجاد شده:

  • به درستی استفاده می شود و به راحتی قابل یادگیری و یادگیری است.
  • برای کسانی که می خواهند آن را اصلاح کنند یا آن را اصلاح یا اصلاح کنند کاملاً قابل درک است.
  • در میان همه آشنایان و غریبه های بالقوه با اطمینان بیشتری به اشتراک گذاشته و دریافت شوید.
  • در بین مردم توده بهتری داشته باشید.

اقدامات خوب: مستندات - Readme

اقدامات خوب: مستندات

مبانی

در مورد توسعه نرم افزار آزاد و منبع آزاد، بطور کلی، کاربران اصلی اسناد مربوط به طراحی محصول ، مواردی هستند که هستند یا خواهند بود مسئول نگهداری از همان و بدون داشتن مستندات خوب و یا فاقد اسناد ، تنها گزینه مناسب این است که مستقیماً آن را کاوش کنید ، تا به آن برسید طراحی و عملکرد آن را درک کنید.

ایجاد مستندات خوب در هنگام انجام کار توسعه نرم افزار رایگان ، منبع باز یا هر نوع نرم افزار دیگر ، ارسال به گیرندگان احتمالی آن است (کاربران ، مدیران ، نگهدارندگان یا سایر توسعه دهندگان) برای یافتن راهی از طریق جنگل بدون نقشه و قطب نما.

مستندات خوبی برای هر یک ایجاد کنید نرم افزار رایگان ، منبع آزاد همچنین سودمند است ، گرچه مستند سازی هزینه داردسرمایه گذاری اگر درست انجام شود ارزش آن را دارد. زیرا ، جهان نرم افزار پر از داستان در مورد است کدهای قدیمی از برنامه ها ، برنامه ها یا سیستم های قدیمی یا فعلی که فقط تعداد کمی از افراد جرات لمس آنها را دارند ، زیرا تقریباً هیچ کس نمی فهمد. برنامه نویسان بر ایجاد کد و مستند نکردن صحیح و کامل آن تمرکز دارند. و این باید اصلاح شود.

روشهای خوب مستند سازی در پرونده های متنی README

در مورد نرم افزار رایگان و منبع آزاد، اسناد اغلب به پرونده های متنی محدود می شود ، هنگامی که توسط افراد یا گروه های کوچکی از برنامه نویسان یا انجمن ها ایجاد می شود. اما ، تا ایجاد یک اسناد ساده با استفاده از یک ساده فایل متنی README.md (یا .txt) شما می توانید خود را داشته باشید بهترین یا بهترین روشها، نکات یا راهنمای مفید ایجاد ، کاملترین و جزئی ترین اطلاعات لازم در مورد ایجاد شده را به اشخاص ثالث برسانید.

برای مقاله ما ، روشهای خوب تصور شده و توسط "طرح ابتکاری کد" از بانک توسعه اینترآمریکن، که به روش خلاصه به ما می گوید که مستندات خوب بر اساس a فایل متنی README.md (یا .txt) ساختار آن باید به صورت زیر باشد:

ساختار فایل README توصیه می شود

  • شرح و زمینه: بخشی که در آن شما باید ویژگی ها ، زمینه ای که در آن توسعه یافته و مشکلات توسعه ای که به حل آن کمک کرده است را توصیف کنید.
  • راهنمای کاربر: بخشی که در آن باید دستورالعمل هایی برای کاربر نهایی در مورد نحوه استفاده از ابزار دیجیتال ذکر شود.
  • راهنمای نصب: بخشی که باید به دستورالعمل نصب برای استفاده مجدد و پیکربندی ابزار دیجیتال اشاره شود. این بخش برای توسعه دهندگان در نظر گرفته شده است.
  • نویسندگان بخشی که اعتبارات باید به همکاران ابزار داده شود.
  • مجوز برای کد ابزار: بخشی که مجوزهای داده شده به اشخاص ثالث برای استفاده مجدد از ابزار دیجیتال باید مشخص شود.
  • مجوز برای مستند سازی ابزار: بخشی که در آن باید نوع مجوز موجود در اسناد ایجاد شده ذکر شود.

در این شیوه های خوب، آنها همچنین توصیه می کنند به مستندات فایل README برای کاملتر کردن آن ، بخشهای زیر:

  • نحوه مشارکت: بخشی که به توسعه دهندگان جدید روند کمک به پروژه ها را توضیح می دهد.
  • کد رفتار: بخشی که آیین نامه رفتار را توضیح می دهد ، هنجارها ، قوانین و مسئولیت های اجتماعی را تعیین می کند که افراد و سازمان ها هنگام تعامل با ابزار دیجیتال یا جامعه خود باید از هر روشی تبعیت کنند.
  • نشان ها: بخشی نشان ها (تصاویر کوچک جاسازی شده در README.md) را نشان می دهد که به روش خوانا و مختصر وضعیت ابزار را مشخص می کند.
  • نسخه: بخشی که لیستی از نسخه های ابزار دیجیتال و ویژگی های اضافه شده به هر نسخه را نشان می دهد.
  • تشکر و قدردانی: بخشی که شامل تقدیرنامه ها از سایر افراد یا سازمان هایی است که به طریقی در پروژه مشارکت داشته اند.

برای گسترش این اطلاعات ، در روشهای خوب در امور مستندات برای توسعه نرم افزار رایگان، توسط "طرح ابتکاری کد" از بانک توسعه اینترآمریکن می توانید روی پیوند زیر کلیک کنید: مستندات - راهنمای انتشار ابزارهای دیجیتال. و در سایر نشریات ، بخشی را که به آن اشاره شده است ، بررسی خواهیم کرد شیوه های خوب در مورد ارزیابی و صدور مجوز از نرم افزار آزاد و آزاد خودشان

نتیجه

نتیجه

ما امیدواریم که این "پست کوچک مفید" در مورد «Buenas prácticas» در زمینه «documentación» برای ایجاد در هنگام توسعه «Software libre y abierto»، برای کل از علاقه و سودمندی برخوردار باشد «Comunidad de Software Libre y Código Abierto» و سهم بزرگی در انتشار اکوسیستم فوق العاده ، غول پیکر و رو به رشد برنامه های کاربردی برای و «GNU/Linux».

و برای کسب اطلاعات بیشتر ، همیشه در بازدید از هیچ گونه دریغ نکنید کتابخانه آنلاین مانند OpenLibra y JedIT خواندن کتاب (PDF) در مورد این موضوع یا موارد دیگر حوزه های دانش. در حال حاضر ، اگر این را دوست دارید «publicación», اشتراک گذاری آن را متوقف نکنید با دیگران ، در شما وب سایت ها ، کانال ها ، گروه ها یا انجمن های مورد علاقه از شبکه های اجتماعی ، ترجیحا رایگان و آزاد به عنوان مادادون، یا مانند امن و خصوصی تلگراف.

یا به سادگی از صفحه اصلی ما در دیدن کنید از لینوکس یا به کانال رسمی بپیوندید تلگرام از DesdeLinux برای خواندن و رأی دادن به این یا سایر نشریات جالب در «Software Libre», «Código Abierto», «GNU/Linux» و سایر موضوعات مرتبط با «Informática y la Computación»، و «Actualidad tecnológica».


محتوای مقاله به اصول ما پیوست اخلاق تحریریه. برای گزارش یک خطا کلیک کنید اینجا.

اولین کسی باشید که نظر

نظر خود را بگذارید

نشانی ایمیل شما منتشر نخواهد شد. بخشهای موردنیاز علامتگذاری شدهاند با *

*

*

  1. مسئول داده ها: میگل آنخل گاتون
  2. هدف از داده ها: کنترل هرزنامه ، مدیریت نظرات.
  3. مشروعیت: رضایت شما
  4. ارتباط داده ها: داده ها به اشخاص ثالث منتقل نمی شوند مگر با تعهد قانونی.
  5. ذخیره سازی داده ها: پایگاه داده به میزبانی شبکه های Occentus (EU)
  6. حقوق: در هر زمان می توانید اطلاعات خود را محدود ، بازیابی و حذف کنید.