گزارش اول
شناخت استانداردهاي ساخت و مستند‌‌سازي محصولات نرم‌‌افزاري

بخش چهارم - معرفي استاندارد مستند‌‌سازي نرم‌‌افزار  در سازمان NASA

1- مقدمه
استاندارد مستندسازي نرم‌‌افزار سازمان NASA براي پشتيباني ازمستندسازي همه توليدات نرم‌‌افزاري آن سازمان طراحي گرديده است. مهمترين هدف اين استاندارد ارائه يك چارچوب و مدل براي ثبت اطلاعات اساسي مورد نياز در طول چرخه ساخت و نگهداري سيستمهاي نرم‌‌افزاري مي‌‌باشد. از نظر مدير پروژه، وقتي اين استاندارد بصورت موفقيت‌‌آميز بكار گرفته شده است كه حداقل نيازهاي مستندسازي بر طبق معيارهاي زير برآورده شده باشد :
• اهداف مستندسازي پروژه پوشش داده شده باشد
• توصيف واضحي از مديريت، مهندسي و پروسه‌‌هاي تضمين و نرم‌‌افزار توليدي ارائه شده باشد
• ثبات فرمت مستندات در كل پروژه حفظ شده باشد
• قابليت دنبال كردن رويه‌‌هاي غير استاندارد به نحوي بيان شده باشد
• قابليت رديابي مابين خروجيهايي كه در هر فاز چرخه حيات توليد مي‌‌شوند از طريق اين استاندارد وجود داشته باشد

2- ساختار استاندارد
استاندارد يك ساختار DID سطح بالا را براي يك مجموعه مستندات ارائه مي‌‌كند. براي هر جلد از مستندات نيز يك DID مجزا ارائه شده است كه قالب و محتواي اطلاعات در هر جلد را مشخص مي‌‌نمايد. كل مستندات توليد شده براي يك پروژه در چهار قسمت اصلي سازماندهي مي‌‌شود كه هر كدام مي‌‌تواند در يك جلد مجزا ارائه گردد. اين چهار قسمت عبارتند از :
• مستندات طرح مديريتي (Management Plan)
اين مجموعه شامل تمامي اطلاعات مربوط به طرح پروژه، مديريت، مهندسي و طرح تضمين كيفيت خواهد بود.
• مستندات توصيف محصول نرم‌‌افزاري (Product Specification)
تمامي مستندات تكنيكي مربوط به محصول در اين مستندات جمع‌‌آوري مي‌‌شود
• رويه‌‌هاي آزمون و تضمين (Assurance & Test Procedure)
مستندات مربوط به انجام آزمايشات و تضمين در اين قسمت گرد‌‌آوري مي‌‌شود
• گزارشهاي مديريتي، مهندسي و تضمين (Management Engineering and Assurance Report)
اين قسمت نيز شامل تمامي گزارشات اعم از گزارشات مديريتي، مهندسي و تضمين خواهد بود

كل استاندارد در شش بخش و شش ضميمه سازماندهي شده است. شش بخش اول، بدون پرداختن به جزئيات، اطلاعات كلي را در مورد مستندات ارائه مي‌‌نمايد. در واقع محتواي اصلي مستندات در ضمايم A تا F اين استاندارد گنجانده شده است كه شامل چهار قسمت ذكر شده در بالا مي‌‌باشد. هر يك از ضمايم از مجموعه‌‌اي از DID تشكيل شده است. ضميمه A يك DID است كه فهرست كنترلي(Checklist) از تمامي اطلاعات مستندات ارائه مي‌‌كند و فقط عناوين را شامل مي‌‌شود. ضميه B شامل دو DID مي‌‌باشد كه چارچوب و ساختار مستندات ارائه شده را بيان مي‌‌كند. درواقع اين ضميمه شامل يك DID سطح بالاست كه بقيه DIDs به عنوان (Template DID) از آن تبعيت مي‌‌كنند. ضميمه‌‌هاي C تا F نيز يك مجموعه DID براي فرمت و محتواي مستندات براي چهار قسمت ذكر شده در بالا ارائه مي‌‌نمايند.

بخش‌‌ها و ضمايم استاندارد بطور اجمالي در زير معرفي مي‌‌گردد.
بخش 1- حاوي پيشنهاد، دامنه (Scope)و كاربرد استاندارد
بخش 2- حاوي ارجاعات، اختصارات، تعاريف و واژه‌‌نامه
بخش 3- حاوي تمامي نيازهاي مشخص شده شامل نيازهاي عمومي، نيازهاي ويژه اعمال استاندارد، نيازها و قوانين براي ايجاد مستندات مبتني بر استاندارد تعيين شده
بخش 4- حاوي نكات تضمين كيفيت
بخش 5- حاوي نكات بسته‌‌بندي كه با توجه به اينكه براي آنان استانداردي اعمال نمي‌‌شود لذا استفاده‌‌نمي‌‌گردد
بخش 6- حاوي اطلاعات مفيد اضافي شامل توضيحات و مثالها
ضميمه A - حاوي يك فهرست كنترلي براي اعمال استاندارد
1. ضميمهB - حاوي دو DID اصلي براي ايجاد مستندات مي‌‌باشد. يك DID سطح بالا كه عناوين اصلي را در بر مي‌‌گيرد و يك DID به عنوان قالب مستندات(Template DID).
ضميمه C - حاوي DID هاي مربوط به طرح مديريتي (Management Plan DID)
ضميمه D - حاوي DID هاي مربوط به توصيف محصول نرم‌‌افزاري (Product Specification DID)
ضميمه E - حاوي DID هاي مربوط به رويه‌‌هاي آزمون و تضمين (Assurance & Test Procedure DID)
ضميمه F - حاوي DID هاي مربوط به گزارشهاي مديريتي، مهندسي و تضمين (Management Engineering and Assurance DID)

3- معرفي اجمالي ضمايم استاندارد
همانطور كه در بالا ملاحظه شد، محتواي اصلي استاندارد در ضمايم A تا F تشريح شده است، در نتيجه شرح مختصري راجع به هر يك از اين ضمايم در زير ارائه مي‌‌گردد.

3-1- ضميمه A : فهرست كنترلي براي مجموعه مستندات
اين ضميمه شامل يك سري اطلاعات جزيي به شكل فهرست‌‌وار از محتواي مستندات مي‌‌باشد. اين فهرست مي‌‌تواند توسط مدير پروژه به عنوان فهرست كنترلي براي دنبال كردن DID ها استفاده گردد. هنگامي كه از اين ضميمه به عنوان فهرست كنترلي استفاده مي‌‌شود بايستي قوانين ذكر شده در بخش 3.2 از استاندارد پيروي شود.

3-2- ضميمه B : تعريف قالب مستندات
اين ضميمه داراي يك DID با شماره P000 شامل توصيفاتي براي ساختار، فهرست مطالب و محتواي DID¬S مستندات و يك DID با شماره P999 براي قالب مستندات مي‌‌باشد. اين دو DID براي پشتيباني ساختار مستندات پروژه‌‌ها استفاده مي‌‌شوند.

DID مربوط به مجموعه مستندات نرم‌‌افزاري يك مرجع سطح بالا (Top Level) از مستندات مي‌‌باشد و به تمامي چهار جلد از مجموعه مستندات استاندارد رجوع مي‌‌كند. اين چهار جلد مي‌‌تواند در يك مجموعه مستندات يا بصورت مجزا تعريف شوند.

DID مربوط به قالب مستندات، شكل فرمت هر مستند را بيان مي‌‌كند. اين فرمت حاوي مقدمه، مستندات مرتبط، ساختار مستندات، تعاريف، اختصارات، و ... مي‌باشد.

3-3- ضميمه C : توصيف طرح مديريتي
اين ضميمه شامل توصيفاتي براي ساختار، فهرست مطالب و محتواي DID مربوط به طرح مديريتي (Management Plan) مي‌‌باشد. بخش اصلي اين قسمت به تعدادي DID مجزا از هم تقسيم شده است. اين قسمت شامل هشت DID مجزا از هم براي بخشهاي مختلف طرح مديريتي مي‌‌باشد كه در قالب يكنواخت ارائه گرديده و عبارتند از :


1. Acquisition Activities Plan
2. Development Activities Plan
3. Training Development Plan
4. Sustaining Engineering and operation Activities Plan
5. Assurance Plan
6. Risk Management Plan
7. Configuration Management Plan
8. Delivery and Operational Transition Plan

3-4- ضميمهD : توصيف محصول نرم‌‌افزاري
اين ضميمه حاوي توصيفاتي براي فرمت و محتواي DID مربوط به محصول نرم‌‌افزاري مي‌‌باشد. مباحث مربوط به توصيف محصول نرم‌‌افزاري به هشت قسمت مجزا از هم تفكيك شده كه در استاندارد براي هر قسمت يك DID مجزا ارائه شده است. DIDS ارائه شده در اين ضميمه عبارتند از :

1.Concept
2. Requirements
3. Architectural Design
4. Detailed Design
5. Firmware Support Manual
6. Version Description
7. User’s Guide
8. Operational Procedure Manual


3-5- ضميمه E : رويه‌‌هاي آزمون و تضمين
در اين ضميمه محتوا و فرمت مستندات مربوط به تضمين كيفيت و رويه‌‌هاي تست و آزمون بيان شده است.
مباحث مربوط به رويه‌‌هاي آزمون و تضمين به 9 قسمت مجزا از هم تفكيك شده و براي هر قسمت يك DID مجزا تدوين شده است. DIDS ارائه شده در اين ضميمه عبارتند از :



1. Quality Assurance Procedures Verification and Validation Procedures
2. Inspection , Review , and Analysis Procedures Testing Procedures
3. Unit Test Procedures
4. Integration Test Procedures
5. Acceptance Test Procedures
6. Quality Engineering Assurance Procedures
7. Safety Assurance Procedures
8. Security and Privacy Assurance Procedures
9. Certification Procedures


3-6- ضميمه F : گزارشهاي مديريتي و تضمين
در اين ضميمه محتوا و فرمت گزارشهاي مديريتي، مهندسي و تضمين بيان شده است. مباحث مربوط به گزارش‌‌هاي مديريتي، مهندسي، و تضمين نيز به دوازده قسمت مجزا از هم تفكيك شده و براي هر قسمت يك ¬DIDs مجزا تدوين شده است. اولين DID (NASA- DID-ROOO) ، رئوس مطالب كل اين ضميمه را پوشش مي‌‌دهد. DIDS ارائه شده در اين ضميمه عبارتند از :

1. Management, Engineering ,and Assurance Report
2. Certification Report
3. Audit Report
4. Inspection Report
5. Discrepancy (NRCA) Rport
6. Engineering Change Proposal
7. Lessons Learned Report
8. Performance/Status Report
9. Assurance Activity Report
10.Test Report
11. Waiver /Deviation Request
12. Review Report