فراتر از کد: درک ارزش اسناد

بررسی اجمالی

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

مورد استفاده: سیستم پرواز

با فرض اینکه با تیمی کار می کنید که در حال ساختن سیستم های توزیع شده، به ویژه یک اپلیکیشن میکروسرویس است. بیایید نمونه ای از یک سیستم پرواز را در نظر بگیریم که از سه ریزسرویس تشکیل شده است: customer-service، flight-service، و email-service. علاوه بر این، سیستم شامل اجزای مختلفی مانند پایگاه داده، حافظه پنهان و پیام رسانی است.

می توانید تصور کنید؟ البته که می توانی. با این حال، در واقعیت، تخیل به تنهایی کافی نیست. در اختیار داشتن منابع ملموس بسیار مهم است. به همین دلیل ضروری است که اولین سند خود را به نام «طراحی سطح بالا» (به اختصار HLD) آماده کنید.

بعد از مشاهده نمودار چه احساسی داشتید؟ احساس بهتری می کنی، نه؟

نمودارهای UML

به عنوان یک مهندس نرم افزار، باید از نمودارهای UML آگاه باشید، ممکن است تعجب کنید، آیا سند خود کد کافی نیست؟ چیزی مثل java-doc یا شاید swagger! اگرچه پشتیبانی از کد خود با این اسناد کاملاً خوب است، اما برای هم تیمی شما برای درک “طراحی راه حل” شما کافی نیست.

مثال

با فرض اینکه یک API دارید که رزرو واقعی پرواز را انجام می دهد.

API کارهای زیر را انجام می دهد:

• اعتبار سنجی ورودی
• صدا زدن customer-service برای دریافت جزئیات مشتری
• به روز رسانی پایگاه داده
• ارسال ایمیل از طریق email-service

حال سوال این است که هم تیمی شما چگونه می تواند بداند؟

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

در اینجا، نمودار توالی وارد عمل می شود.

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

نتیجه

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