مستندسازی

1. مستندسازی

2. انواع مستندات • مستندسازی فرایند مستندسازی کاربر • مستندسازی محصول مستندسازی سیستم

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

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

5. مستندسازی کاربر • بطور کلی کاربران سیستم را دو دسته فرض میکنیم: کاربران نهایی، اداره کنندگان سیستم. • برای تغذیه این دو دسته ی مختلف حداقل 5 سند متفاوت باید نوشته شود. • جزوه ی راهنما (چگونگی کار و پیاده سازی سیستم) اداره کنندگان سیستم • کتابچه ی مرجع(جزئیاتی از امکانات سیستم) کاربران مجرب • کتابچه ی معرفی(شروع کارباسیستم) کاربران مبتدی • مستندات نصب(چگونگی نصب سیستم) اداره کنندگان سیستم • توصیف تابعی(توصیف سرویسهای تهیه شده) ارزیابهای سیستم

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

7. ساختمان مستندات • صفحه ی جلد (پروژه، مشخصات سند، تاریخ تولید، گیرندگان سند، محدودیت، چکیده یا واژگان کلیدی و تذکر حق کپی) • مستندات دارای صفحات زیاد را باید به چند فصل تقسیم کرد که هر فصل شامل فهرستی از بخشهای هر فصل باشدو شماره صفحه باید بصورت فصل – صفحه باشد. • تهیه ی واژه نامه ی تخصصی.

8. استاندارهای مستندسازی • استانداردهای فرایند • استانداردهای محصول • استانداردهای تبادل

9. استانداردهای فرایند • این استانداردها روشی را تعیین میکنندکه باید در تولید مستندات پیش گرفت تا کیفیت بالای آنهاتضمین شود. مرحله 1: ایجاد سند(واژه پردازها، پردازشگرهای جدول ومقالات، بسته های نرم افزاری و ترسیمی) • ایجادپیش نویس، بازنویسی پیش نویس، دربرگرفتن پیشنهادات بازبینی، پیش نویس مجددسند مرحله 2: پردازش(غلط گیرهای املایی) • غلط گیری متن، سند تست شده، تست نهایی مرحله 3: تولید(بسته های نشررومیزی، برنامه های تایپی، و بسته های artwork) • طرح متن، مرورطرح، تولید چاپ اصلی، تکثیر

10. استانداردهای محصول • ویژه ی کنترل خود مستندات هستند؛ مانند: • استانداردهای شناسایی یک سند( بطور انحصاری) از میان چند مستند، استانداردهای ساختار مستندات، استانداردهای ارائه( فونت و بولت و...)

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