در مستند سازی نرم افزار یکی از مهم ترین چالش ها پیدا کردن تعادلی میان سادگی و جزییات می باشد. C4 Model یک رویکرد مدرن برای مستند سازی نرم افزار می باشد که با مستند سازی نمای کلی سیستم تا کد این مشکل را تا حدود زیادی حل کرده و به ما اجاز می دهد به شکلی ساده و قابل فهم با تعادلی مناسب این کار را انجام دهیم. این رویکرد از چهار سطح تشکیل شده است که هدف آن ارائه یک تصویر ساده برای توسعه دهنده ها, معمارها و افراد غیر فنی می باشد. این مدل برای کاهش پیچیدگی و شفافیت در داکیومنت ها بسیار مفید و کاربردی می باشد.
بیایید این 4 سطح را با استفاده از یک مثال بانکی بررسی کنیم
Context: یک نمای کلی از سیستم به همراه تمام ارتباط ها آن با سیستم ها و کاربران نشان می دهد. این سطح یک دید کلی و سطح بالا از سیستم به ما می دهد تا افراد غیر فنی نیز بتوانند آن را درک کنند. برای مثال نشان داده می شود که یک سیستم بانکی با چه سرویس های خارجی مانند سیستم پرداخت در ارتباط می باشد.
Container: یک نمای کلی تر از بخش های اصلی سیستم که به آن کانتینر می گویند مانند سرویس ها, دیتابیس ها و نحوه ارتباط آن ها به ما می دهد. هر کانتینر معمولا یک برنامه اجرایی می باشد که بخشی از یک سیستم را پیاده سازی کرده است. این بخش برای نشان داده ساختارها و تقسیم بندی سیستم به توسعه دهنده ها و معمارها کاربرد دارد. برای مثال در یک سیستم بانکی می تواند سرویس های مربوط به حساب ها, تراکنش ها, دیتابیس ها و... به همراه ارتباط های آن ها باشد.
Component: این بخش مربوط به بخش های داخلی هر کانتینر می باشد که جزییات آن ها را به شکل کامل نشان می دهد. این به توسعه دهنده ها و معمارها کمک می کند که ساختار دقیق هر بخش از سیستم را بهتر درک کنند. برای مثال کانتینر مربوط به سرویس تراکنش ها را در نظر بگیرید, این سطح بخش های داخلی مثل ماژول ها, نحوه تعامل با دیتابیس و... را نشان می دهد.
Code: این بخش در پایین ترین سطح اطلاعات دقیقی از ساختار کدها به ما نشان می دهد. از آن برای مستند سازی معماری و پیاده سازی های کد استفاده می شود که باعث می شود بتوانیم به جزئیات و ساختارهای داخلی کدها مانند کلاس ها, متدها و... دسترسی داشته باشیم. برای مثال در یک سیستم بانکی می تواند ساختار کدها, کلاس ها, متدها, کنترلرها و... را به ما نشان بدهد.
برای اطلاعات بیشتر به لینک زیر مراجعه کنید:
https://c4model. com/
در پایان، باید توجه داشته باشیم که مستند سازی نرم افزار نباید تنها به چشم یک وظیفه اضافی دیده شود، بلکه باید به عنوان یکی از بخش های اصلی در فرایند توسعه نرم افزار به آن توجه شود. مستند سازی زمانی ارزشمند می باشد که همگام با تغییرات پیش برود و همیشه وضعیت واقعی پروژه را نشان دهد.
