کتاب مهارت عمومی برنامهنویسی به قلم محمدرضا شکرریز با هدف آشنایی مقدماتی با مفاهیم مدیریتی و روش صحیح و اصولی کار در شرکتهای برنامهنویسی به رشتهی تحریر درآمده است.
مهارتهای عمومی برنامهنویسی، از نوع مهارتهایی است که بیشتر پس از کسب تجربه در محیطهای برنامهنویسی حاصل میشود. بسیاری از این نوع مهارتها را نمیتوان به صورت مستقیم به برنامهنویسان مبتدی آموزش داد.
در بخشی از کتاب مهارت عمومی برنامهنویسی میخوانیم:
مستندسازی به دو دسته کلی مستندسازی داخلی و مستندسازی خارجی تقسیم میشود. مفهوم مستندسازی داخلی به
مستنداتی اشاره دارد که درون کد اصلی قرار گرفتهاند و مستندات خارجی در واقع همان دفترچههای راهنما هستند.
عواملی که کیفیت مستندات را تحت تاثیر قرار میدهند، شامل استانداردهای مستندسازی، فرایند حصول اطمینان از
کیفیت مستندات و شیوۀ نوشتاری میباشند. اگر این موارد به خوبی رعایت شوند، مستندات برای آزمایش برنامه، رفع اشکالات و یا افزودن موارد جدید به نرمافزار، کارایی بیشتری خواهند داشت.
مستندات وابسته به سیستم نرمافزاری، دارای چند شرط است:
١- باید به عنوان محیط ارتباطی بین اعضای تیم توسعه، عمل کنند.
۲- باید یک انبار اطلاعاتی سیستم باشد تا مهندس نگهدارنده سیستم بتواند از آن استفاده کند.
۳- باید اطلاعاتی برای مدیریت فراهم آورد تا در طراحی، تعیین بودجه و برنامهریزی فرایند گسترش نرمافزار به وی کمک کند.
۴- برخی از مستندات باید به کاربر بگویند که چگونه سیستم را اداره کند و به کار گیرد.
برآوردن این شرطها نیازمند انواع متفاوتی از مستندات است که ممکن است از مستندسازی غیررسمی گرفته تا مستندسازی حرفهای ایجاد شده در جزوات راهنمای کاربر به دست آیند. مهندسان نرمافزار، مسئول تولید و ایجاد اکثر این مستندسازیها هستند، هر چند مؤلفان فنی نیز ممکن است به پرداخت نهایی اطلاعاتی که به بیرون داده میشود، کمک کنند.