Program Documentation(مستند سازی نرم افزار)

program documentation : هر متن نوشتاری ، تصاویر یا ویدئویی که یک نرم افزار یا برنامه را برای کاربران خود توصیف کند ، برنامه یا سند نرم افزاری نامیده می شود. کاربر می تواند هرکسی باشد مانند  یک برنامه نویس ، تحلیلگر سیستم و سرپرست برای کاربر نهایی . در مراحل مختلف توسعه ، اسناد متعددی برای کاربران مختلف ایجاد می شود. در حقیقت ، مستندات نرم افزاری یک فرآیند مهم در فرایند کلی توسعه نرم افزار است.

program documentation در برنامه نویسی ماژولار اهمیت بیشتری پیدا می کند زیرا ماژول های مختلف نرم افزار توسط تیم های مختلف تولید می شوند. اگر کسی غیر از تیم توسعه بخواهد یا نیاز به درک یک ماژول داشته باشد ، مستندات خوب و مفصل کار را آسانتر می کند.

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

اینها چند راهنما برای ایجاد اسناد هستند –

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

سند باید بدون ابهام باشد

هیچ تکراری نباید باشد

از استانداردهای مطلوبی باید استفاده شود

اسناد همیشه باید به روز شوند

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

مزایای مستندات

تمام قسمتهای یک نرم افزار یا برنامه را ردیابی می کند

تعمیر و نگهداری آسانتر است

برنامه نویسان غیر از توسعه دهنده می توانند همه جوانب نرم افزار را درک کنند

کیفیت کلی نرم افزار را بهبود می بخشد

در آموزش کاربر کمک می کند

عدم تمرکز دانش ، کاهش هزینه ها و تلاش را در صورت ترک ناگهانی افراد از سیستم ، تضمین می کند

اسناد نمونه

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

دفترچه راهنمای کاربر – این دستورالعمل ها و مراحل را برای استفاده نهایی از ویژگی های مختلف نرم افزار در اختیار کاربران نهایی قرار می دهد.

دفترچه راهنمای عملیاتی – کلیه عملیات های انجام شده و وابستگی متقابل آنها را فهرست و توصیف می کند.

Document Design – به یک مرور کلی از نرم افزار می پردازد و عناصر طراحی را با جزئیات شرح می دهد. جزئیات آن مانند نمودارهای جریان داده ، نمودارهای رابطه موجودیت و غیره را اسناد می کند.

مستندات مورد نیاز – لیستی از کلیه ملزومات سیستم و همچنین تجزیه و تحلیل قابلیت دوام در مورد نیازها را دارد. این می تواند موارد کاربر ، سناریوهای مجدد و غیره را داشته باشد.

مستندات فنی – این یک اسناد از مؤلفه های واقعی برنامه نویسی مانند الگوریتم ها ، نمودارهای جریان ، کدهای برنامه ، ماژول های کاربردی و غیره است.

Testing Document – این برنامه ، برنامه آزمون ، پرونده های آزمایشی ، برنامه اعتبار سنجی ، برنامه تأیید ، نتایج آزمون و غیره را ضبط می کند.

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

 

منبع: tutorialspoint.com