مستندسازی بخش بزرگی از روند تولید نرم افزار است که متاسفانه نادیده گرفته می‌شود. خوب است یادآوری کنم که در شرکت‌های مطرح نرم افزاری دنیا، مستندسازی جزو پرهزینه‌ترین واحد‌هاست. روش کار به این صورت است که کارشناسان مستندسازی در جلسات متعدد و منظم با تیم توسعه، به تدریج اسناد لازم را که شامل مستندات تجربه کاربری، مستندات فنی و راهنمای کاربر است را تهیه، آرشیو و بروزرسانی می‌کنند. ما در ایران کمتر تولیدکننده‌ای می‌شناسیم که به طور جدی به این ردیف شغلی مهم توجه کند و شاید واقعا علت عمر پایین محصولاتی که تولید می‌کنیم همین باشد. با این حال من بعنوان یک توسعه‌دهنده یک کار روزانه به مجموعه وظایفم به طور روتین اضافه کردم که حداقل بتوانم در یادآوری آنچه مثلا در شش ماه گذشته بعنوان کد نوشته ام کمکی کرده باشم. همچنین به تدریج می‌توان از دست نوشته های هر روز یک سندفنی معتبر از چیزی که تولید کرده‌ام ایجاد و به توسعه‌دهنده‌ی بعدی منتقل کنم. سند سورس کد (Source code document) یک سند سورس کد بخشی فنی است که تشریح می کند کدها چگونه کار می کنند. درحالی که ضروری نیست جنبه هایی که بیشترین پتانسیل سردرگمکی را دارند، پوشانده شوند. کاربران اصلی اسناد سورس کد مهندسین نرم افزار یا برنامه نویسان دیگر هستند. اسناد سورس کد ممکن است شامل موارد زیر باشند (توجه داشته باشید محدود به این موارد نمی شود): - چارچوب تولید، زبان و دیگر فریمورک های استفاده شده - نوع اتصال داده ها (data binding) - الگوهای طراحی با مثال (model-view-controller) - معیارهای امنیت - دیگر الگوها و اصول به نظر من اگر در جایی کار می‌کنید که فعلا همکاری بعنوان کارشناسان مستندسازی در کنارتان نیستند، از همین امروز و به تدریج شروع به ایجاد مستندات فنی کنید. * لینک زیر یک قالب نمونه بعنوان سندفنی نرم افزار ارائه کرده که می تواند سرنخ کاملی از یک مستند استاندارد باشد:
https://readthedocs.org/projects/roboy-sw-documentation-template/downloads/pdf/lite/
