نکاتی برای انجام مستندسازی چابک

یکی از چهار اصل بیانیه توسعه نرم افزار چابک این است:

«نرم افزار کارکننده بالاتر از مستندات جامع»

این مساله گاه باعث می شود که در تیم ها و شرکت هایی که بر اساس روش های چابک کار می کنند، این تصور ایجاد شود که نیازی به مستند سازی وجود ندارد، یا مستند سازی بر خلاف اصول چابکی است. باید توجه داشت که هرچند در بیانیه چابکی نسبت به ارجحیت نرم افزار کارا به مستندات جامع اشاره می شود، این به معنی نیست که مستندات مهم نیستند.

مستند سازی در روش های چابک همچنان اهمیت خود را حفظ می کند. مستندات سمت کاربر همچنان باید درجای خود باشند تا کاربر بتواند به خوبی از سیستم استفاده کند. مستندات مربوط به توسعه سیستم نیز می تواند نقش مهمی در برقراری جریان دانش در سازمان داشته باشد.

با توجه به ذات روش های چابک، که در آن باید همواره سرعت و بهینه گی را حفظ کرد، رعایت نکات زیر در هنگام نوشتن مستندات می تواند کمک زیادی به انجام این وظیفه کند:

1. مستندات سنتی بیشتر در مورد کارهایی بود که قصد انجامشان را داشتیم، اما مستندات چابک بیشتر برای بیان این است که چه کاری انجام داده ایم.
2. مستندات باید تنها در حداقل میزان مورد نیاز نوشته شوند. توجه داشته باشید:
   • زمان صرف شده برای نوشتن مستندات، از میزان فایده آن بیشتر نباشد
   • در چه مواردی واقعا نیاز داریم؟ این مستندات در آینده چقدر به درد خواهد خورد؟
3. به خاطر شرایط پویای روش های چابک، مستندات در مرور زمان دقت خود را از دست می دهند. پس نکات مهم زیر را در نظر داشته باشید:
   • اگر مستندات مربوط به تعیین انجام کاری هستند،  آن را تا جای ممکن نزدیک به انجام کار بنویسید
   • مستندات باید به روز شوند. البته تنها در صورت نیاز. قرار نیست زمان زیادی را برای به روز رسانی های نالازم صرف کنیم
4. مستندات باید تا جای ممکن خلاصه و کوتاه باشند. نوشتن جزییات نالازم یا موارد بدیهی را کنار بگذارید.
5. مستندات تا جای ممکن سطح بالا باشند. برای جزییات از کد برنامه نوشته شده و کامنت های آن استفاده کنید.
6. مستندات باید با همکاری افراد درگیر نوشته و تکمیل شوند، نه تنها یک نفر.
7. مستندات نباید تکراری باشند، اگر کسی قبلا آن را نوشته، تنها یک ارجاع به مطلب موجود کافی است.
8. تنها برای مسایل خاص و پیچیده مستندات بنویسید. مسایل ساده و روتین نیاز زیادی به مستندات ندارند.
9. اگر پاسخ مساله در اینترنت (مثلا stackoverflow و …) موجود است، نباید خودتان دوباره آن را بنویسید، یک ارجاع به آن آدرس کافی است. (مگر این که تغییر خاصی در روش داده باشید.) اگر امکان می دهید که جواب ممکن است در سایت مورد نظر جابجا شود، متن آن را در صورت امکان (با حفظ حقوق مالک و ذکر منبع) کپی کنید.
10. سادگی را رعایت کنید. از جداول و نمودارهای پیچیده استفاده نکنید.
11. ویکی ها یکی از مناسب ترین راهکارها برای مستندات توسعه سیستم هستند.
12. حتما توجه داشته باشید که مستندات به راحتی و با سرعت در دسترس افراد مربوط باشند. افراد نباید زمان زیادی را برای یافتن مستندات مورد نیازشان صرف کنند. از دسته بندی و برچسب های مناسب استفاده کنید.
13. همیشه در نظر داشته باشید که نوشتن مستندات یک سرمایه گذاری است. قبل از انجام آن به بازگشت این سرمایه فکر کنید. زمانتان را بیهوده پای مستند نویسی نگذارید.
14. اگر کاربر از شما مستندات می خواهد، دلیل او را بپرسید. در اکثر اوقات کاربر واقعا نیازی به مستنداتی که میخواهد ندارد.
15. همیشه توجه داشته باشید که برای انتقال دانش و تجربه میان کارکنان، گفتگو و ارتباط شخصی بسیار کاراتر از مستندات است. بنابراین بهبود بسترهای ارتباطی میان افراد را همیشه در نظر داشته باشید.
16. در نهایت، توجه داشته باشید که مستند نویسی هم یکی از نیازمندی های سیستم محسوب می شود که باید با اولویت بندی صحیح و به اندازه صحیح پاسخ داده شود.