Architecture Decision Record

Active theme: Light

← اسناد

پیشنهادهایی برای نوشتن ADR خوب

ویژگی‌های یک ADR خوب:

  • دلیل و منطق: دلایل اتخاذ آن AD مشخص را توضیح دهید. این می‌تواند شامل زمینه (پایین‌تر ببینید)، مزایا و معایب گزینه‌های مختلف، مقایسهٔ ویژگی‌ها، بحث هزینه/فایده و موارد دیگر باشد.

  • مشخص بودن: هر ADR باید دربارهٔ یک AD باشد، نه چند AD.

  • برچسب زمانی: مشخص کنید هر مورد در ADR چه زمانی نوشته شده است. این امر به‌ویژه برای جنبه‌هایی که ممکن است با گذشت زمان تغییر کنند، مانند هزینه‌ها، زمان‌بندی‌ها، مقیاس‌پذیری و مانند آن‌ها اهمیت دارد.

  • تغییرناپذیری: اطلاعات موجود در ADR را تغییر ندهید. در عوض، با افزودن اطلاعات جدید ADR را اصلاح کنید، یا با ایجاد ADR جدید آن را جایگزین کنید.

ویژگی‌های یک بخش «زمینه» خوب در ADR:

  • وضعیت سازمان و اولویت‌های کسب‌وکار خود را توضیح دهید.

  • دلایل و ملاحظاتی را که بر ترکیب اجتماعی و مهارتی تیم‌های شما مبتنی است، بگنجانید.

  • مزایا و معایب مرتبط را بگنجانید و آن‌ها را به شکلی توصیف کنید که با نیازها و اهداف شما همسو باشد.

ویژگی‌های یک بخش «پیامدها» خوب در ADR:

  • توضیح دهید که از اتخاذ تصمیم چه چیزی نتیجه می‌شود. این می‌تواند شامل اثرات، نتایج، خروجی‌ها، پیگیری‌ها و موارد دیگر باشد.

  • اطلاعاتی دربارهٔ ADRهای بعدی بگنجانید. نسبتاً رایج است که یک ADR نیاز به ADRهای بیشتری ایجاد کند، مثلاً وقتی یک ADR انتخاب بزرگ و فراگیری انجام می‌دهد که به‌نوبهٔ خود نیاز به تصمیم‌های کوچک‌تر بیشتری ایجاد می‌کند.

  • هر فرایند بازبینی پس از اقدام را بگنجانید. برای تیم‌ها معمول است که هر ADR را یک ماه بعد مرور کنند تا اطلاعات ADR را با آنچه در عمل رخ داده مقایسه کنند و یاد بگیرند و رشد کنند.

یک ADR جدید ممکن است جای ADR قبلی را بگیرد:

  • وقتی AD‌ای اتخاذ می‌شود که ADR قبلی را جایگزین یا بی‌اعتبار می‌کند، باید یک ADR جدید ایجاد شود