انواع مستند سازی:
- مستند سازی برای سطوح متفاوتی از نرم افزار
- مستند سازی مشخصات سیستم برای استفاده (درون سازمانی)
- مستند سازی زیر بخشهای مشترک برای تعیین قالب ها (درون سازمانی)
- مستند سازی برنامه برای کاربرهای میانی (درون سازمانی)
- مستند سازی نرم افزار برای کاربر نهایی
- موفقیت یک پروژه ارتباط مستقیمی با سطح پشتیبانی از نیازها و خواسته های کاربر نهایی دارد
اهمیت مخاطب مستند:
مخاطب مهمترین عنصر در یک مستند سازی موفق
وظیفه اصلی یک مستند : انتقال اطلاعات لازم به مخاطب
باید دقیقا بدانید:
- اطلاعات قبلی مخاطب
- اطلاعات مورد نیاز مخاطب
- بهترین و سریعترین راه انتقال اطلاعات به کاربر
عدم شناخت دقیق مخاطب بزرگترین تهدید برای یک مستند است.
اهمیت انتخاب لغت و سازگاری ـ یک مستند سلسله مراتبی از دستورات است که مخاطب را برای انجام یک کار در سیستم راهنمایی می کند. پس متن مستند باید:
- دقیق و خالی از هرگونه ابهام
- کوتاه و توصیفی
- خالی از غلط
- سازگار از نظر لغوی
- سازگار از نظر معنایی
- و … باشد
عناوین مطالب:
- انواع مستندسازی
- اهمیت مخاطب
- اهمیت انتخاب لغت و سازگاری
- اهمیت ساختار
- اهمیت فهرست
- اهمیت ویرایش و بازبینی
- ابزارهای موجود
- و …