چطوری داکیومنت خوب بنویسیم؟
`

چطوری داکیومنت خوب بنویسیم؟

چطوری داکیومنت خوب بنویسیم؟

90
2 ماه پیش
0

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

مستندات تاثیر زیادی بین ایجاد ارتباط ادما با کامیپوتر ها میشن.

 

چرا باید داکیومنت بنویسی

برای شما :

      - بعد ماه ها میتونید کدهاتون رو اسون بخونید

      - شما میخواین برنامه نویسای دیگه کدهای شما رو بخونن و نظر بدن

      - میخواید خودتون و نحوه کد نوشتنتون رو بشناسید

      - دیگران تشویق میشن که توی کدهای شما مشارکت کنن

 

برای دیگران :

      - دیگران بتونن براحتی کدهای شما رو استفاده کنن و روش حساب کنن

 

برای جامعه علمی :

      - علم رو پیش ببرید

      - دنیای اپن سورس رو حمایت کنید

      - امکان تکرار و شفافیت رو فراهم کنید

 

بهترین تمرین برای ساخت داکیومنت :

    1- فایل README با محتویات زیر داشته باشید که شامل محتویات زیر باشه :

          - طرح مختصری از پروژه

          - روال نصب و اجرا

          - اموزش یا نمونه کد کوتاه

    2-  دنبال کردن تون رو برای دیگران باز بزارید

    3- برای API مستندات بنوسید

          - توابع چکاری انجام میدن

          - توابع چه پارامتر ها یا ارگومان هایی دارن

          - توابع چه چیزی برمیگردونن

  4- برای کدهاتون داکیومنت بنویسید

    5- برای شرکت کننده ها در کدهاتون،اطلاعات لازم بنویسید

    6- اطلاعات منبع و مستند رو قید کنید

    7- اطلاعات لایسنس را قید کنید

    8- به ایمیلتون لینک بزارید تا بهتون پیام بدن

    9- نسخه های مختلف از کد رو که تغییر میدید در معرض دیگران قرار بدید تا مطلع بشن

شما میتونید از  اینجا  براحتی فایل README درست کنید و توی پروژه هاتون استفاده کنید.

در کل استاندارد ها و راه حل های زیادی هست برای داکیومنت یا مستند سازی پروژه یا کدهاتون.

ولی معمولا از ابزار هایی استفاده میشه که توی نت فراونه و سفارش هم شده که من یه سری هاش رو میگم اینجا.

برچسب ها :
  • داکیومنت
نظر خود را بنویسید...