نوشتن unit test برای مستندات پروژه
ایده‌ای برای کمک به استانداردسازی و اطمینان از بروز بودن مستندات پروژه
مدتی پیش ایده‌ای رو خوندم که مناسب دیدم با شما هم مطرح کنیم: ایده نوشتن unit test برای مستندات.
این ایده‌ای است که می‌خوام در شروع پروژه بعدی ازش استفاده کنم. در مقاله بالا با مثالی از پروژه اپن‌سورس نویسنده مقاله، توضیح داده شده که چطور و برای چه بخش‌هایی unit test نوشته شده. همچنین به این سوال پاسخ داده شده که در ابتدای کار که هنوز مستندات نداریم آیا تست بنویسیم یا خیر؟ چون نوشتن تست در این حالت باعث fail شدن کل پروسه و احتمالاً عدم نسخه‌بندی و استقرار نرم‌افزار می‌شه.
مستندات در کنار کد
پایه اصلی این ایده اینه که مستندات رو در کنار کد نگهداری کنیم. وقتی این کار رو کردیم در کنار تست‌هایی که برای کد می‌نویسیم می‌تونیم تست‌هایی هم برای مستندات بنویسیم. دو مزیت عمده دیگه هم برای نوشتن مستندات در مخزن کد می‌شه در نظر گرفت:
- می‌تونید بروزرسانی مستندات رو هم بخشی از پروسه Code Review قرار بدید.
- به کمک این کار می‌تونید مستندات نسخه‌بندی شده داشته باشید. در واقع هر نسخه release شده کد، همراه خودش نسخه release شده مستندات مربوط به همون نسخه از کد رو هم داره.
نظر شما چیه؟ این ایده رو ایده خوبی می‌بینید؟