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

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

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

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

در اینجا سه مرحله متصل به هم وجود داراست که می توانید برای تایپ کردن داکیومنت عالی استعمال نمائید، پیش از اینکه خیلی دیر خواهد شد.

1. با یادداشت‌های ظریف استارت فرمائید

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

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

چرا سیاق خاصی را به مکان روال دیگر گزینش کرده‌اید

پیوند‌هایی که برای امداد تصاحب کردن از آنها بازدید کرده‌اید

ترتیب ایفا امور

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

2. تصمیمات را به طور عظیم‌خیس توضیح دهید

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

شما میخواهید مطمئن گردید که محتوا، ایده‌ها و تصمیم‌گیری‌ها، زمانی آنها را برای خویش توضیح می‌دهید، کلیه در ذهنیت شما نو میباشند.

یادداشت‌های کوتاه خویش را مرور نمائید و آغاز به پیشرفت آنها در تایپ کردن محاوره‌ای نمایید. کاری که جاری ساختن می‌دهید را طوری تعریف نمایید که گویی آن را به فرد دیگری فراگیری می‌دهید. ممکن میباشد اینگونه جملاتی باشد:

اینجانب معمولا این شغل را ایفا می ‌دهم، البته این توشه تصمیم گرفتم کاری گوناگون اعمال دهم چون...

معضل‌هایی که با آن رو به رو گردیده‌اید و طریق غلبه بر آنان

تصمیمات معماری که هدف ها پروژه شما‌را حمایت می‌نماید

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

3. از علم موردنیاز غافل نشوید

این مرحله عالی میباشد پس از یک استراحت زمان بر ناهار، یا این که حتی روز آن‌گاه صورت پذیرد. داکیومنت خویش را مجدد بخوانید و جاهای خالی را که بعد از مسافت تصاحب کردن دربین خویش و پروژه‌یتان معین می گردد را مالامال نمایید.

برای تایپ کردن یا این که دستکم لینک و پیوند شدن به علم لازم، توجه بیشتری فرمائید، به خصوص در حالتی‌که مرتبا از گویش‌ها و ابزارهای گوناگون استعمال می کنید. حتی شغل های خرد مانند گذاشتن لینک و پیوند در مستندات API قادر است در بعدی از ساعتها کاوش کردن شما دوری کرده و در وقت‌تان صرفه‌جویی نماید.

پیوند به READMEs، پروسه نصب، و بقیه مورد ها حفاظت مربوطه را بنویسید یا این که پیوند نمایید. اقدامات command-line که مرتبا اجرا می‌دهید را طوری برای خویش آراسته یا این که حتی اتوماتیک فرمایید که هر توشه که به پروژه برمی‌شوید، بدون چاره به جاری ساختن شغل های معمول نباشید.

شما به راحتی می توانید جزئیات مدد را حتی بعد از استراحت کوتاهی از پروژه خویش فراموش نمایید. پس هر توشه که هر چیزی را سودمند یافتید آن را یادداشت نمائید.

تمامی مفاد را مستند نمایید

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

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