قالب مستند معماری نرم‌افزار
...
سند زیر شامل بخشی از قالب پیشنهادی سند معماری نرم‌افزار است. هرچند همین بخش هم قابل استفاده و مفید است، جهت دریافت نسخه کامل و جدید قالب سند معماری نرم‌افزار، لطفاً با کاملتر و جدیدتر این سند در قالب خدمات تیم چکاپ ارائه می‌شود. جهت آشنایی با خدمات تیم چکاپ به این‌جا مراجعه فرمایید و یا با آدرس checkup@asta.ir تماس بگیرید.
پیش‌گفتار: در مستند معماری نرم‌افزار، معماری یک سامانه نرم‌افزاری توصیف می‌شود. معماری نرم‌افزار، شامل تصمیمات مهم و کلان در طراحی نرم‌افزار است. هر آن چه از دید کلان و از دید معماری مهم است، در این مستند گنجانده می‌شود و جزئیات و فرعیات (مانند جزئیات پیاده‌سازی) در این مستند گنجانده نمی‌شود. قالب مطالب و سرفصل‌های لازم برای مستند معماری در ادامه آمده است. مستند معماری باید این سرفصل‌ها را به شکلی شفاف و مناسب، در کوتاه‌ترین و موجزترین حجم ممکن پوشش دهد. همچنین تغییرات مهم در نرم‌افزار که از نظر معماری مهم هستند، باید در سند معماری منعکس شوند. به عبارت دیگر، مستند معماری باید در طول فرایند توسعه نرم‌افزار، نگهداری و به‌روز شود.
...
اگر ارجاع به مستند یا مرجع دیگری لازم است، در این بخش ذکر شود.
2. نمای موارد کاربرد
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
3. ویژگی‌های کیفی
در این بخش، ویژگی‌های غیرکارکردی (Nonfunctional) یا به عبارت دیگر ویژگی‌های کیفی (Quality Attributes) مورد نیاز در سامانه نرم‌افزاری موردنظر ذکر شود. به عنوان مثال امنیت، کارایی، مقیاس‌پذیری و ...
...
8. نماهای متقاطع (اختیاری)
برای مشاهده محتوای این بخش حذف شده است.به نسخه کامل قالب سند معماری مراجعه نمایید.
9. نحوه تحقق موارد کاربرد کلیدی
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
10. نمای تست
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
11. مدیریت لاگ
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
12. پایش (Monitoring)
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
13. نمای داده
در این بخش، تصمیمات مهمی که در زمینه داده‌های سامانه گرفته شده ذکر می‌شود. به عنوان مثال، نحوه ذخیره داده‌ها، نوع پایگاه داده‌های مورد استفاده (sql/nosql/…)، مدیریت داده‌ها و فراداده‌ها، الگوها و تکنیک‌های اصلی در لایه داده (مثل CQRS و محل استفاده از Cache)، فرایند‌های پشتیبان‌گیری و بازیافت داده‌ها، امنیت داده‌ها و ساختار داده‌های کلیدی سیستم.
...
OLAP, Data-warehousing, Report Engines, Report Generators, Report Designers, Materialized View, Denormalization, Power BI, Jasper Reports, BERTBIRT, ...
در این بخش، طراحی کلان امکاناتی که برای گزارش‌گیری تعبیه شده است، ذکر شود. با کمک محتوای این فصل، به سؤالات و دغدغه‌هایی مثل موارد زیر پاسخ داده می‌شود:
...
15. الگوها و تکنیک‌های مورد استفاده
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
16. ابزارها و فناوری‌ها
در این بخش، مجموعه ابزارها، استانداردها، الگوها و فناوری‌های مورد استفاده در توسعه محصول که از جنبه معماری اهمیت دارند، مرور می‌شود. برای هر ابزار یا استاندارد، در صورت امکان نسخه (version) و جایگاه استفاده هم ذکر شود. در واقع، جایگاه همه یا اکثر این موارد در فصلهای قبلی تبیین شده است و در این فصل، فهرستی از این موارد به صورت تجمیعی و متمرکز ذکر می‌شود. این فصل فقط شامل یک جدول است شامل سه ستون است:
...
17. مهم‌ترین تصمیمات معماری
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
18. ریسک‌ها و بدهی‌های فنی
محتوای این بخش حذف شده استبرای مشاهده محتوای این بخش به نسخه کامل قالب سند معماری مراجعه نمایید.
19. بهبودهای پیشنهادی در آینده
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
20. سایر نماهای مفید/لازم
...
- چرخه اول: نگارش فضای مسأله.
در این چرخه، یک دور (چرخه) تلاش شود و نیمه اول سند معماری که شامل «فضای مسأله» است، مستند شود. فضای مسأله شامل فصلهای «مقدمه»، «نمای موارد کاربرد» و «ویژگی‌های کیفی» است. پس از این چرخه، صورت مسأله و نیازمندی‌های کلان نرم‌افزار مشخص می‌شوند. ترتیب پیشنهادی:- مقدمه
- نمای موارد کاربرد
- ویژگی‌های کیفی
- چرخه دوم: توصیف طراحی کلان سامانه نرم‌افزاری، شامل فصلهای «نمای منطقی» ، «نمای پردازه» و «ابزارها و فناوری‌ها». ترتیب پیشنهادی:
- نمای پردازهنمای استقرارمنطقی
- ابزارها و فناوری‌ها
- بازنگری فصلهایی که قبلاً نگارش شده
- چرخه سوم: تکمیل سایر فصلهای اصلی جهت توصیف معماری کلان. ترتیب پیشنهادی:
- نمای پردازه
- نمای استقرار منطقی
- نمای توسعه و پیاده‌سازی
- نماهای متقاطع (در صورت نیاز)
- بازنگری فصلهایی که قبلاً نگارش شده
- چرخه چهارم. ترتیب پیشنهادی:
- فصل نحوه تحقق موارد کاربرد کلیدی
- نمای تست
- نمای داده
- الگوها و تکنیک‌های مورداستفاده
- ریسک‌ها و بدهی‌های فنی
- بازنگری فصلهایی که قبلاً نگارش شده
- چرخه پنجم. ترتیب پیشنهادی:
- سایر فصلهای باقی‌مانده
- بازنگری فصلهایی که قبلاً نگارش شده
...
اشتباه‌های رایج در نگارش سند معماری
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.
پیوست
فایل قالب پیشنهادی
برای مشاهده محتوای این بخش حذف شده استبه نسخه کامل قالب سند معماری مراجعه نمایید.