نام نام خانوادگی : محمدرضا معاویان –امیر دره شوری موضوع : مستند سازی نرم افزار استاد : سعدی

1. به نام خدا نام نام خانوادگی : محمدرضا معاویان –امیر دره شوری موضوع : مستند سازی نرم افزار استاد : سعدی دانشگاه : کارون سال تحصیلی : 91-92 منبع : tech republic

2. مستند سازی :

3. تعریف تخصصی مستند سازی نرم افزار : مستند سازي به نوعي انباركردن اطلاعاتي است كه براي پشتيباني سيستم استفاده مي شود و بدين شكل اطلاعات مديريتي جهت كمك به طراحي، تعيين بودجه و برنامه ريزي فرآيند توسعه فراهم مي شود .مستند سازي براي آموزش كاربران سيستم بسيار مفيد خواهد بود . مستند سازي يكي از بخش هاي مهم جريان توليد نرم افزار است.

4. هدف از مستند سازی :

5. مستند سازی در دو بخش صورت می گیرد : مستند سازی فرایند توسعه شامل بخش های زیر می باشد: • -طرحها، برآوردها و زمانبنديها • - گزارشها كه در مورد پيشرفت كارداده شده باشد ( حين فرآيند و توسعه) • - استانداردها يا متريك هايي كه در طراحي استفاده شده اند. • - گزارشهاي كاري : ارتباط مختلفي كه بخشها به هم دارند و پيشرفت آنها • - مشكلات و راه حلها

6. -توجيه هاي فني راجع به تصميمهاي گرفته شده • - يادداشتهاي و پيامهاي مبادله شده بين اجزاء مختلف • - ارتباط بين مديران و مهندسان خواهد بود و معمولا بعد از به نتيجه رسيدن • -پروژه اين اطلاعات نگهداري نمي شوند بلکه بايگاني و راكد مي شوند . مستند سازی محصول : براي مستند سازي محصول بايد سيستم و كاربر را در نظر گرفت. بخشي در باره سيستم و بخشي از مستندات براي كاربر تهيه خواهد شد .

7. مستند ات سیستم : حاوي اطلاعات مربوط به پياده سازي سيستم . نيازمنديهاي اوليه . ساختار معماري كلي سيستم . توصيف ساختار برنامه ها و ليست كد منبع مي باشد . بهمراه مستندات فاز ارزيابي ( چه نوع تستهايي روي سيستم انجام شده ؟ چه جوابهايي داده شده؟ ...) و راهنماي نگهداري سيستم و مشكلات شناخته شده آن . مستندات کاربر : با اين مستندات بايد به كاربر ديد كلي از سيستم داد.اين بخش بايد بتواند تعريفي غيررسمي سيستم ارائه كند و نحوه نصب برنامه را نيز شامل شود . امكانات موجود در سيستم و كاربرد آنها را با استفاده از تكنيكهاي مختلف رسم تشريح كند.به كاربرنشان دهد چگونه از سيستم استفاده كند.

8. توجه داشته باشيد كه مستندات دو نوع هستند : 1- مستندات داخلي 2- مستندات خارجي . مستندات داخلي شامل توضيحات داخل كد و امكانات help داخل برنامه مي شود و مستندات خارجي شامل يك سري جزئیات . مستند ات كار گرا(Task-Oriented Documentation): مستندات بايد Task-Oriented باشد يعني توجه داشته باشيم مستندات براي اين طراحي شده اند كه مشكلات كاربران را حل نمايند نه اينكه نحوه كار برنامه را توضيح دهند پس بايد با كار كاربران تطابق داده شده باشد . با استفاده از ساختار مناسب و گرافيك مستندات را معنا دار كنيم ، بنحوي كه مستندات باعث شوند نرم افزار متناسب با هر كار قابل دسترس باشد . با ايجاد ايندكس، ارجاعات بين بخشي و ساختار واضح حالتي فراهم بياوريم كه كاربر بتواند به طریقه دلخواه خود به مستندات دسترسي و از آنان استفاده كند . ،

9. پیاده سازی، آزمایش وتست , مستند سازی : پیاده سازی آن قسمت از فرآیند تولید نرم افزار به شمار می رود که مهندسان نرم افزار در دنیای واقعی تمام کد های پروژه را می نویسند و به قول معروف برنامه نویسی می کنند. تست و آزمون نرم افزار بخش لاینفک و مهم از فرآیند تولید نرم افزار است . این قسمت از فرآیند ها کمک می کند تا مشکلات سیستم بصورت سریع شناسایی شوند. مستند سازی در تمام مراحل پروژه همچون : طراحی داخلی نرم افزار برای تعیین اهداف سیستم، نگهداری آینده و ارتقاء و بهبودی سیستم هرچند پروژه پایان یافته باشد انجام می شود.همچنین ممکن است این مستند سازی شامل نوشتن ساختار تکه های برنامه ظاهربرنامه کاربردی داخلی و خارجی هم باشند.این مطلب خیلی مهم است که همه چیز پروژه مستند سازی شود .

10. نگاه به مستند سازی از جنبه دیگر : مستندسازی از دیدگاه اغلب برنامه‌نویسان و توسعه‌دهندگان نرم‌افزار، کاری کسل‌کننده و تلف‌کننده‌ی وقت است، و با آن به عنوان کم ارزش‌ترین جزء چرخه‌ی توسعه‌ی نرم‌افزار برخورد می‌کنند. اما در واقع مستندسازان متبهر و دست‌به‌قلم نقشی بسیار مهم‌تر از اعتباری که به آن داده شده بازی می‌کنند. با توجه به پاسخ‌های متداول به سؤالات کاربران، پشتیبانی از مستنداتی همانند، راهنمای کاربران یا فهرست تقلب‌های فنی، هم برای کاربران و هم برای توسعه‌دهندگان مزایایی را به همراه دارد. به کاربران فرصت دریافت کارایی و خدمات بیشتر را از آنچه خریداری کرده‌اند می‌دهد و همچنین هزینه‌های توسعه‌دهندگان را برای پشتیبانی بعد از فروش کاهش می‌دهد.

11. برای مستند سازی باید از 6 قدم زیر پیروی کرد : 1- درک مخاطبین : یکی از مهم‌ترین مسائلی که به شما در بهبود مستندات کمک می‌کند، دریافت درک مناسبی از مخاطب مستند است. کشف آمار دقیق کاربران از نظر سن، سطح مهارت در نرم‌افزار، قصد آنها از بکارگیری نرم‌افزار و مشکلات رایجی که با آنها دست و پنجه نرم می‌کنند، امری ضروری است. بعد از دریافت چنین دانش و اطلاعاتی می‌توانید درباره‌ی سطح مهارت مستندتان تصمیم‌گیری نمایید؛ مثل لحن و زبان گویش، عمق مطالبی که می‌بایست عنوان گردد و مقیاس‌هایی که مناسب مستند می‌باشد.

12. 2- تعیین حوزه : پس از شناخت مخاطب، نوبت به تعریف حوزه‌ی مستندتان می‌رسد. فهم واضح هدف مستندتان و گستره‌ی اهدافی که قصد رسیدن به آن را دارید، بسیار حائز اهمیت می‌باشد. به هنگام تعیین حوزه، عواملی همچون مهارت فعلی کاربر، بستره‌ی سخت‌افزاری و نرم‌افزاری که قرار است در مورد آن بحث شود،سطح اطلاعات مورد نیاز برای عیب‌یابی، میزان جزئیات فنی مناسب برای گروه کاربران، را مدنظر داشته باشید. این‌ها سؤالات بزرگی است و تعریف حوزه‌ی مستندتان هم کار کوچکی نیست و نیازمند شناختی شفاف و واضح از مخاطب به همراه سطح دانش آنها است.

13. ۳- تعریف قرارداد‌های قالب و شمایل مستند : پس از آن که مخاطبین و حوزه مشخص گردید، نوبت به صرف اندکی زمان برای تعریف قالبِ مستند می‌رسد. این مرحله کار سازمان‌دهی و قالب‌بندی اطلاعات را در مراحل بعد آسان می‌کند. مسلماً شما می‌بایست تصمیم به استفاده از سرفصل و زیرمجموعه‌ی آن، قالبی برای انواع مختلف متون و قرارداد نام‌گذاری برای جداول، نمودارها و تصاویر، اتخاذ ‌کنید. همچنین ظاهر اجزاء صفحه همانند عناوین بخش‌ها ، سربرگ صفحه، پاصفحه و شماره‌ی صفحه را در این مرحله مشخص می‌کنید.

14. ۴- ایجاد پیش‌نویس فهرست مطالب : ایجاد یک پیش‌نویس از فهرست مطالب مستند در مراحل اولیه، کار بسیار خوبی است، زیرا به شما امکان تعیین گستره‌ی عناوین و سرفصل‌ها را می‌دهد. سپس می‌توانید به دسته‌بندی داده‌ها در قسمت‌های مختلف بپردازید و به همراه آن، اطلاعات ناخواسته را از فهرست تصفیه نمایید. در حالی که در این مرحله عناوین اطلاعات از یک بخش به بخش دیگر تغییر می‌کند، می‌توانید هر یک را با خلاصه و چکیده‌ای شروع کنید که شامل هدف مستند، قراردادهای مورد استفاده، واژه‌نامه اصلاحات و در انتها با اطلاعات عیب‌یابی و یا فهرست ضمیمه‌های حاوی داده‌های فنی که در فضای عادی این مستند نمی‌گنجد، به پایان برسانید.

15. ۵- نهایی کردن فهرست مطالب، شروع ایجاد مستند : پس از ایجاد پیش‌نویس فهرست مطالب، تمام فکر تان را بر روی جمع‌اوری تمام اطلاعاتی که برای ایجاد مستند نیاز دارید، متمرکز کنید. به هنگام جمع‌آوری داده‌ها، آنها را با توجه به پیش‌نویس فهرست، امتحان و بازآزمایی کنید تا اطمینان حاصل کنید که “جایی برای هر چیز هست و هر چیز جایی دارد”. حتماً باید زیرعنوان‌های پیش‌نویستان را برای اصلاح هر چه بهتر جزئیات اطلاعاتی، تغییر دهید؛ این امری طبیعی است و در جدول زمان‌بندی‌تان هم می‌بایست برنامه‌ای برای آن داشته باشید. پس از سازمان‌دهی همه‌ی اطلاعات و نهایی کردن فهرست مطالب، کار اصلی برای تولید محتوا آغاز می‌شود.

16. 6-انجام بازنگری فنی و کاربری : بعدازآن که فهرست مطالب را نهایی کردید،تمامی محتویات لازم ایجاد نمودید،قالب‌بندیرا همان‌گونه که از قبل انتظار می‌رفت،طبق قراردادها، انجام دادید و براساس طرح اولیه با توجه به مخاطب و حوزه‌ی مورد نظر، بازنگری نمودید زمان آن فرا میرسد که با نگاهی تیزبین، مطالب را بررسی نمایید. مطلوب آن است که این چشمان، به یک یا تنی چند از مخاطبین نهایی تعلق داشته باشند، زیرا آنها در بهترین جایگاه برای اعمال نظر در مورد پوشش نیازمندی‌هایشان که مستند به آنها اشاره دارد، قرار دارند.