چطور مستندات (داکیومنت) خوبی بنویسیم

چطور مستندات (داکیومنت) خوبی بنویسیم

در این مقاله، ما دلیل فراموش کردن نحوه کار پروژه را در سه مرحله توضیح می‌دهیم. در تیم‌های برنامه‌نویسی همیشه باید همه چیز مستند شود. مستندات همیشه باید در کنار کد قرار بگیرند.

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

برخلاف تصورات رایج، باارزش‌ترین مستندات نرم‌افزاری اصولا برای افراد دیگر نوشته نمی‌شود. راز داکیومنت خوب، نوشتن آن در حین نوشتن کد است. قبل از اینکه این مستندات برای شخص دیگری باشد، شما اولین مخاطب خود هستید. توضیح دهید که چه کاری قرار است خودتان انجام دهید. در آینده از خود تشکر خواهید کرد!

در اینجا سه مرحله متصل به هم وجود دارد که می‌توانید برای نوشتن داکیومنت خوب استفاده کنید، قبل از اینکه خیلی دیر شود.

1. با یادداشت‌های دقیق شروع کنید

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

یک داکیومنت را در کنار کد خود باز نگه دارید و مواردی مانند دستورات، تصمیمات و منابع مورد استفاده را یادداشت کنید. این امر می‌تواند شامل موارد زیر باشد:

چرا متد خاصی را به جای متد دیگر انتخاب کرده‌اید

لینک‌هایی که برای کمک گرفتن از آن‌ها بازدید کرده‌اید

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *