بخشی از پاورپوینت
اسلاید 1 :
انواع مستند سازي
مستند سازي براي سطوح متفاوتي از نرم افزار
مستند سازي مشخصات سيستم براي استفاده (درون سازماني)
مستند سازي زير بخشهاي مشترک براي تعيين قالب ها (درون سازماني)
مستند سازي برنامه براي کاربرهاي مياني (درون سازماني)
...
مستند سازي نرم افزار براي کاربر نهايي
موفقيت يک پروژه ارتباط مستقيمي با سطح پشتيباني از نيازها و خواسته هاي کاربر نهايي دارد
اسلاید 2 :
اهميت مخاطب مستند
مخاطب مهمترين عنصر در يک مستند سازي موفق
وظيفه اصلي يک مستند : انتقال اطلاعات لازم به مخاطب
بايد دقيقا بدانيد :
.1اطلاعات قبلي مخاطب
.2اطلاعات مورد نياز مخاطب
.3بهترين و سريعترين راه انتقال اطلاعات به کاربر
عدم شناخت دقيق مخاطب بزرگترين تهديد براي يک مستند است.
اسلاید 3 :
اهميت انتخاب لغت و سازگاري
يک مستند سلسله مراتبي از دستورات است که مخاطب را براي انجام يک کار در سيستم راهنمايي مي کند. پس متن مستند بايد :
دقيق و خالي از هرگونه ابهام
کوتاه و توصيفي
خالي از غلط
سازگار از نظر لغوي
سازگار از نظر معنايي
و ... باشد
اسلاید 4 :
اهميت ساختار
در دستورالعمل :
توضيح کامل نتيجه کاري که مخاطب انجام مي دهد قبل از دستورالعمل
رعايت ترتيب منطقي قدم ها
عدم حذف هيچکدام از قدم ها (حتي قدم هاي خيلي کوتاه و ساده)
در متن مفهومي :
اعلان پيش نيازهاي هر مطلب جديد
توضيح مطالب ابتدايي پيش از پرداخت به مطالب پيشرفته
خود را جاي مخاطب خود بگذاريد و مثل او فکر کنيد !
اسلاید 5 :
اهميت فهرست
اکثر کاربران در اولين قدم به فهرست مستند رجوع مي کنند تا مطلب مورد نظر خود را پيدا کنند.
بنابراين شما بايد مطمئن باشيد که مخاطب با عدم آگاهي از واژه دقيق اطلاعات مورد نياز خود را پيدا مي کند !
اسلاید 6 :
اهميت ويرايش و بازبيني
مستند بعد از نوشتن آخرين کلمه تمام نمي شود !
وظيفه ويرايشگر :
بررسي گرامر ، املا لغات ، سازگاري لغوي و سازگاري ساختاري
وظيفه بازبين (معمولا يکي از توسعه دهندگان) :
بررسي دقت دستوالعمل ها و مفاهيم
بررسي تغييرات اعمال شده در سيستم در حين فرآيند توسعه
اسلاید 7 :
ارزيابي مخاطب
Over time, quality work will lead to an audience for your work.
اسلاید 8 :
شناخت مخاطب
اولين منبع براي شناخت دقيق مخاطب بررسي خود نرم افزار است.
شناخت مخاطب با مشاوره با مدير محصول
مدير محصول معمولا يک ديد انتزاعي از محصول دارد
اِعمال تحليل مخاطب به مستند
بررسي واژه شناسي مخاطب و تعريف واژه ها در صورت نياز
ساختار دهي به مستند جوري که براي کاربر معني دار باشد
چه اتفاقي مي افتد اگر مخاطب خود را اشتباه بشناسيم ؟
هر بخش را براي چه کسي مي نويسيم ؟
تغييرات هنگام تهيه مستند.
واگرايي مخاطبان
اسلاید 9 :
انتخاب کلمات و سازگاري
Consistency and orthogonality are tools of design, not the primary goal in design.
اسلاید 10 :
انتخاب کلمات و سازگاري
تمرين کنيد لغت درست را انتخاب کنيد
براي بعضي مفاهيم يک واژه شناخته شده در صنعت وجود دارد ! (Whamboozle Vs Widget)
ساده و روان
مراجعه به لغتنامه هاي مخصوص واژگان دامنه
از جملات معلوم و کوتاه استفاده کنيد.
لغات اضافي را حذف کنيد
در طول مستند از يک صدای يکتا استفاده کنيد !
شکل سازگار در همه مستند
