جلسه ۱۰ : مستندسازی برنامه – متدولوژی برنامه نویسی

• جزئیات
• نوع محتواآموزشی

عرض ادب و احترام. با دوره ی آموزشی متدولوژی برنامه نویسی (Programming Methodologies) از وب سایت آموزشی پی وی لرن در خدمتتون خواهیم بود. مستندسازی برنامه یا Program Documentation را در این بخش مورد بررسی قرار خواهیم داد و از مزایای مستندسازی برنامه خواهیم گفت.

مستندسازی برنامه یا Program Documentation

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

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

این ها خطوط راهنما (guidelines) برای ایجاد اسناد هستند.

• مستندات باید از نقطه ی دید خواننده باشند.
• سند باید بدون ابهام باشد.
• هیچ دستورالعمل تکراری نباید باشد.
• از استانداردهای صنعت باید استفاده شود.
• اسناد همیشه باید به روز شوند.
• هر سند منسوخ شده باید پس از ثبت توقف (phase out) باید خارج شود.

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

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

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

مثال اسناد

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

• دفترچه راهنمای کاربر (User manual) – این دستورالعمل ها و مراحل را برای استفاده از ویژگی های مختلف نرم افزار در اختیار کاربران نهایی قرار می دهد.
• دفترچه راهنماي عملياتي (Operational manual) – كليه عمليات هاي انجام شده و وابستگي متقابل آن ها را فهرست و توصيف مي كند.
• سند طراحی (Document Design) – به یک مرور کلی از نرم افزار می پردازد و عناصر طراحی را با جزئیات شرح می دهد. جزئیات آن مانند نمودارهای جریان داده ، نمودارهای رابطه موجودیت و غیره را مستند می کند.
• مستندات نیاز (Requirements Document) – دارای لیستی از کلیه نیازهای سیستم و همچنین تجزیه و تحلیل قابلیت دوام نیازها می باشد. می تواند موارد کاربر ، سناریوهای واقعی و غیره را داشته باشد.
• مستندات فنی (Technical Documentat ion) – یک مستندسازی از مؤلفه های واقعی برنامه نویسی مانند الگوریتم ها ، نمودارهای جریان ، کدهای برنامه ، ماژول های عملکردی و غیره است.
• تست سند (Testing Document) – پلن تست، کیس های تست، پلن اعتبار سنجی ، پلن تأیید ، نتایج تست و غیره را ضبط می کند. تست یکی از مراحل توسعه نرم افزار است که به مستندات فشرده نیاز دارد.
• لیست باگ های شناخته شده – هر نرم افزاری دارای باگ ها یا خطاهایی است که نمی توان آن ها را حذف کرد زیرا یا خیلی دیر کشف شده اند یا بی ضرر هستند یا تلاش و زمان بیش تری را برای تصحیح نیاز دارند. این باگ ها با مستندات برنامه ذکر شده اند تا در آینده حذف شوند. همچنین در صورت فعال بودن باگ، آن ها به کاربران ، پیاده سازان و افراد تعمیرکار کمک می کنند.

کلام پایانی

با مستندسازی برنامه یا Program Documentation و مزایای مستندسازی برنامه در این بخش از آموزش  متدولوژی برنامه نویسی آشنا شدیم. در بخش بعدی به بررسی مباحث مربوط به نگه داری برنامه می پردازیم.