کیوان رشادی‌پور

برنامه‌نویس پی‌اچ‌پی در سارینا

مستندسازی فنی در اجایل

فردی در حال فیلمبرداری از هشتگ‌هایی که لب دریاچه آب می‌خورند

از مستندسازی متنفرم. تا همین چندوقت پیش تجربه‌هایم در مستندسازی محدود می‌شد به تکالیف دانشگاهی. در آن تکالیف ما را مجبور می‌کردند تا برای برنامه‌هایمان مستندسازی کنیم. من همیشه در پایان کار چند خط اطلاعات به‌دردنخور می‌نوشتم و همراه برنامه‌هایم می‌فرستادم. با شروع کار در سارینا برای آنکه از عهده‌ی مسئولیت‌های جدید بربیایم، رجوع به یکی دو مستند حسابی کارم را راه انداخت. بعد از آن بود که سعی کردم بر نفرتم به مستندسازی غلبه کنم و ببینم چطور می‌توانم خودم هم مستنداتی این‌چنینی بنویسم. می‌دانم که نفرتم زیاده‌روی است و شاید دلیلش تکالیف اجباری دانشگاه باشد اما تا آنجا که می‌دانم فقط من نیستم که مستندسازی را دوست ندارم. اکثر برنامه‌نویس‌ها همین‌طورند به‌خصوص اگر در گروهی باشند که پروژه‌ها با رویکرد اجایل و اسکرام انجام می‌شوند. این تمایل البته غیرمنطقی هم نیست. در بیانیه‌ی توسعه‌ی نرم‌افزار چابک هم آمده که نرم‌افزاری که کار می‌کند از مستندسازی جامع بهتر است؛ اما آیا این بهتر بودن به این معنا است که دور مستندسازی را کاملاً خط بکشیم؟ مسلماً نه اما برای مستندسازی باید چه‌کار کنیم؟ بگذارید بهتر بپرسم: چرا، چه‌وقت، چه‌چیز را، چقدر و چگونه مستندسازی کنیم؟ پاسخ به این پنج سوال تا حد زیادی بستگی به ویژگی‌ها، کار و تیم شما دارد. برای آنکه این عوامل را در نظر بگیریم، در ادامه سعی می‌کنم این پنج سوال را به سوال‌های بیشتر و واضح‌تر بشکنم. فرض بر این است که از اجایل استفاده می‌کنیم و همچنین اینجا منظور از مستندسازی، قسمت فنی است که مخاطبش توسعه‌دهنده است و شامل مستندهای راهنما برای کاربران نرم‌افزار و نیز مستندهای بازاریابی نمی‌شود.

ادامه‌ی مطلب را بخوانید