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

این راهنما یک فرآیند کامل از ابتدا تا انتها برای تولید نمودار متناظر پلتفرم تحویل غذا با استفاده از C4-PlantUML را نشان می‌دهد. شما یاد می‌گیرید چگونه از یک نمودار تولیدشده توسط هوش مصنوعی به کد قابل ویرایش PlantUML بروید، مدل را در VPasCode بهبود بخشید و ویرایش آن را به صورت بصری در Visual Paradigm Online ادامه دهید. این روش سرعت مدلسازی کمک‌شده توسط هوش مصنوعی را با انعطاف‌پذیری نمودار به عنوان کد و راحتی یک ویرایشگر نمودار گرافیکی ترکیب می‌کند.

Visual Paradigm یک فرآیند عملی برای تبدیل توصیف معماری به زبان طبیعی به یک نمودار متناظر C4 قابل ویرایش ارائه می‌دهد:

1. سیستم را در چت‌بات هوش مصنوعی Visual Paradigm توصیف کنید.

   

2. نمودار متناظر سیستم C4 را تولید و بررسی کنید.

3. نتیجه را به عنوان C4-PlantUML در VPasCode باز کنید.

   

4. نمودار را با ویرایش کد PlantUML ویرایش کنید.

   

5. به طور اختیاری نتیجه را به Visual Paradigm Online ارسال کنید.

   

6. نمودار را به صورت بصری با استفاده از ویرایشگر نمودار کشیدن و رها کردن ویرایش کنید.

این کار به شما دو مسیر ویرایش ارائه می‌دهد:

• ویرایش مبتنی بر کد: VPasCode و C4-PlantUML

• ویرایش مبتنی بر رابط گرافیکی: ویرایشگر نمودار Visual Paradigm Online

ربات چت هوش مصنوعی Visual Paradigm از نمودارهای C4 Context، Container، Component و Deployment پشتیبانی می‌کند. همچنین می‌تواند یک نمودار تولیدشده را با دستورات زبان طبیعی مانند افزودن، حذف، تغییر نام یا اتصال مجدد عناصر بهبود بخشد.

1. درک نمودار متناظر C4

نمودار متناظر C4 نمای سطح بالا یک سیستم نرم‌افزاری است. این نمودار نشان می‌دهد:

• اینسیستم مورد علاقه

• کاربران انسانی و عوامل سازمانی

• سیستم‌های نرم‌افزاری خارجی

• رابطه‌های مهم بین این عناصر

• توضیح کوتاهی درباره نحوه عملکرد هر رابطه

معمولاً این نمودار خدمات داخلی، پایگاه‌های داده، کلاس‌ها، APIها یا جزئیات زیرساخت را نشان نمی‌دهد. این موارد در نمودارهای C4 سطح پایین‌تر قرار می‌گیرند.

برای مثال، یک نمودار متناظر برای یک پلتفرم تحویل غذا آنلاین ممکن است شامل موارد زیر باشد:

• مشتری

• مدیر رستوران

• راننده تحویل

• ارائه‌دهنده پرداخت

• سرویس نقشه و تعیین مکان

• سرویس اعلانات

• پلتفرم تحویل غذا

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

2. آماده کردن یک پیام هوش مصنوعی خوب

کیفیت دیاگرام تولید شده به شدت به توضیح معماری ارائه شده به چت‌بات بستگی دارد.

یک پیام مفید مشخص می‌کند:

• نام سیستم

• هدف سیستم

• افرادی که از آن استفاده می‌کنند

• سیستم‌های خارجی که با آنها ارتباط برقرار می‌کند

• روابط بین آنها

• سطح دیاگرام C4 مطلوب

• فرمت خروجی مطلوب

• چه چیزی باید شامل نشود

پیشنهاد نمونه

یک نمودار متناظر سیستم C4 برای یک پلتفرم تحویل غذا آنلاین ایجاد کنید.

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

افراد:
1. مشتری — رستوران‌ها را مرور می‌کند، سفارش می‌دهد، پرداخت می‌کند و تحویل را ردیابی می‌کند.
2. مدیر رستوران — منوهای رستوران را مدیریت می‌کند، سفارشات را می‌پذیرد و وضعیت سفارشات را به‌روز می‌کند.
3. راننده تحویل — وظایف تحویل را می‌پذیرد و پیشرفت تحویل را به‌روز می‌کند.
4. مدیر عملیات — فعالیت‌های پلتفرم را نظارت می‌کند و مشکلات پشتیبانی را مدیریت می‌کند.

سیستم‌های خارجی:
1. ارائه‌دهنده پرداخت — احراز هویت و دریافت پرداخت‌های مشتریان را انجام می‌دهد.
2. سرویس نقشه و تعیین مکان — آدرس‌ها، مسیرها و مکان‌های تحویل را فراهم می‌کند.
3. سرویس اطلاع‌رسانی — ایمیل، پیامک و اطلاع‌رسانی‌های فوری ارسال می‌کند.

رابطه‌ها:
- مشتری از پلتفرم تحویل غذا برای مرور رستوران‌ها، ثبت سفارش، انجام پرداخت و ردیابی تحویل استفاده می‌کند.
- مدیر رستوران از پلتفرم تحویل غذا برای مدیریت منوها و پردازش سفارشات استفاده می‌کند.
- راننده تحویل از پلتفرم تحویل غذا برای دریافت وظایف تحویل و به‌روزرسانی وضعیت تحویل استفاده می‌کند.
- مدیر عملیات از پلتفرم تحویل غذا برای نظارت بر عملیات و حل مشکلات استفاده می‌کند.
- پلتفرم تحویل غذا از ارائه‌دهنده پرداخت برای احراز هویت و دریافت پرداخت‌ها استفاده می‌کند.
- پلتفرم تحویل غذا از سرویس نقشه و تعیین مکان برای محاسبه مسیرها و ردیابی مکان‌ها استفاده می‌کند.
- پلتفرم تحویل غذا از سرویس اطلاع‌رسانی برای ارسال اطلاع‌رسانی‌ها استفاده می‌کند.

یک نمودار متناظر سیستم C4 تمیز ایجاد کنید. جزئیات داخلی مانند ظروف، مؤلفه‌ها، پایگاه داده، کلاس‌ها یا زیرساخت نصب را نشان ندهید. از برچسب‌های رابطه مختصر استفاده کنید.

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

3. نمودار را در چت‌بات هوش مصنوعی Visual Paradigm تولید کنید

چت‌بات هوش مصنوعی Visual Paradigm را باز کنید و یک مکالمه جدید یا جلسه تولید نمودار شروع کنید.

بسته به رابط و نسخه اشتراک، چت‌بات ممکن است انتخاب‌گر نوع نمودار ارائه دهد. انتخاب کنید:

• مدل C4

• نمودار متناظر سیستم

سپس پیشنهاد را وارد کنید.

روال کلی چت‌بات Visual Paradigm به شرح زیر است:

1. نمودار را توصیف کنید.

2. به هوش مصنوعی اجازه دهید مدل اولیه را تولید کند.

3. نتیجه را بررسی کنید.

4. آن را با دستورات زبان طبیعی بهبود بخشید.

5. صدور کنید یا در ابزار دیگر Visual Paradigm ادامه دهید.

بررسی نتیجه اولیه

بررسی کنید که آیا نمودار شامل موارد زیر است:

• دقیقاً یک سیستم مرکزی

• همه افراد مورد نیاز

• همه سیستم‌های خارجی مرتبط

• جهت‌گیری‌های رابطه صحیح

• توضیحات مختصر روابط

• هیچ سرویس یا پایگاه داده داخلی اضافی

• نام‌گذاری یکنواخت

• چیدمان قابل خواندن

یک نمودار تولیدشده نقطه شروع است، نه جایگزین بررسی معماری.

۴. بهبود نمودار از طریق گفتگو

ربات چت می‌تواند نمودار را با استفاده از زبان عادی ویرایش کند.

یک عنصر اضافه کنید

یک کارمند پشتیبانی مشتری اضافه کنید که از پلتفرم تحویل غذا برای بررسی مشکلات مشتریان و پردازش بازپرداخت استفاده می‌کند.

یک سیستم خارجی اضافه کنید

یک سرویس تشخیص تقلب خارجی اضافه کنید که توسط پلتفرم تحویل غذا برای ارزیابی پرداخت‌های مشکوک استفاده می‌شود.

یک عنصر را تغییر نام دهید

«سرویس اطلاع‌رسانی» را به «سرویس پیام‌رسانی و اطلاع‌رسانی» تغییر نام دهید.

یک رابطه را تغییر دهید

رابطه بین راننده تحویل و پلتفرم تحویل غذا را به صورت زیر تغییر دهید:
«وظایف تحویل را دریافت می‌کند و به‌روزرسانی‌های وضعیت تحویل را ارسال می‌کند.»

یک عنصر را حذف کنید

مدیر عملیات را از نمودار حذف کنید.

چیدمان را بهبود بخشید

نمودار را دوباره چیده کنید به طوری که افراد در بالا، سیستم‌های خارجی در پایین و پلتفرم تحویل غذا در مرکز باقی بماند.

نمودار را ساده‌سازی کنید

این نمودار را به یک نمودار سیستم متناظر C4 ساده و دقیق تبدیل کنید. جزئیات پیاده‌سازی، پایگاه‌های داده، APIها، سرویس‌های مایکروسرویسی و مؤلفه‌های داخلی را حذف کنید.

درخواست بررسی سازگاری کنید

نمودار را برای روابط گم‌شده، برچسب‌های مبهم، سیستم‌های تکراری و عناصری که در یک نمودار متناظر C4 جای ندارند بررسی کنید.

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

بخش ۱: نمودار را در VPasCode برای ویرایش کد باز کنید

۵. از «باز کردن در VPasCode» یا «ویرایش در VPasCode» استفاده کنید

پس از تولید و بهبود نمودار، از عملیاتی با برچسب مشابه استفاده کنید:

• باز کردن در VPasCode

• ویرایش در VPasCode

• باز کردن کد

• تولید کد برای ویرایش

برچسب دقیق دکمه ممکن است بسته به رابط فعلی متفاوت باشد.

این کار کد نمودار را به VPasCode منتقل می‌کند، جایی که می‌توانید نمودار را به عنوان متن ویرایش کنید و همزمان پیش‌نمایش زنده‌ای از آن را مشاهده کنید. Visual Paradigm VPasCode را به عنوان یک ویرایشگر نمودار به صورت کد مبتنی بر مرورگر توصیف می‌کند که از PlantUML، مدل‌های C4، Mermaid، Graphviz و سایر فرمت‌های سینتکس پشتیبانی می‌کند.

کد تولید شده باید از C4-PlantUML استفاده کند، معمولاً با:

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
...
@enduml

اسکریپت تولیدشده ممکن است از آدرس URL متفاوتی برای include استفاده کند یا نسخه‌ای از کتابخانه پشتیبانی شده درونی. include را که VPasCode تولید می‌کند حفظ کنید مگر اینکه دلیل خاصی برای تغییر آن داشته باشید.

6. ساختار C4-PlantUML را درک کنید

یک نمودار مفهومی C4-PlantUML معمول شامل این بخش‌هاست:

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml

LAYOUT_LEFT_RIGHT()

Person(customer, "مشتری", "سفارشات غذا را ثبت می‌کند و تحویل‌ها را ردیابی می‌کند.")
System(platform, "پلتفرم تحویل غذا", "به مشتریان اجازه می‌دهد غذا سفارش دهند و تحویل را ردیابی کنند.")
System_Ext(payment, "ارائه‌دهنده پرداخت", "پرداخت‌ها را تأیید و ثبت می‌کند.")

Rel(customer, platform, "سفارشات ثبت می‌کند و تحویل‌ها را ردیابی می‌کند")
Rel(platform, payment, "پرداخت‌ها را تأیید و ثبت می‌کند")

@enduml

انواع اصلی عناصر

اولین آرگومان شناسه داخلی است. دومین آرگومان نام نمایشی است. سومین آرگومان توضیحات است.

۷. ویرایش نمودار در VPasCode

VPasCode معمولاً نمایش می‌دهد:

• کد منبع در یک پنل ویرایشگر

• نمودار ترسیم شده در یک پنل پیش‌نمایش

• اقداماتی برای صادر کردن، به اشتراک گذاشتن، کپی کردن یا باز کردن نتیجه در یک محصول دیگر Visual Paradigm

VPasCode امکان نمایش زنده را فراهم می‌کند و ویرایش مستقیم کد را پشتیبانی می‌کند. همچنین می‌تواند فرمت‌های نمودار پشتیبانی شده را هنگام چسباندن کد در ویرایشگر تشخیص دهد.

مثال: کد بهبود یافته C4-PlantUML

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml

title پلتفرم تحویل غذا — زمینه سیستم

LAYOUT_LEFT_RIGHT()
SHOW_LEGEND()

Person(customer, "مشتری",
  "بررسی رستوران‌ها، سفارش می‌دهد، پرداخت می‌کند و تحویل‌ها را ردیابی می‌کند.")

Person(restaurantManager, "مدیر رستوران",
  "مدیریت منوهای رستوران، دریافت سفارشات و به‌روزرسانی وضعیت سفارشات.")

Person(deliveryDriver, "راننده تحویل",
  "وظایف تحویل را دریافت می‌کند و پیشرفت تحویل را به‌روز می‌کند.")

Person(operationsAdmin, "ادمین عملیات",
  "عملیات پلتفرم را نظارت می‌کند و مسائل پشتیبانی را مدیریت می‌کند.")

System(platform, "پلتفرم تحویل غذا",
  "امکان‌دهنده سفارش غذا، پرداخت، مدیریت رستوران و ردیابی تحویل است.")

System_Ext(paymentProvider, "ارائه‌دهنده پرداخت",
  "تأیید و دریافت پرداخت‌های مشتری.")

System_Ext(mapService, "سرویس نقشه و تعیین مکان",
  "ارائه آدرس‌ها، مسیرها و داده‌های مکانی.")

System_Ext(notificationService, "سرویس اطلاع‌رسانی",
  "ارسال ایمیل، پیامک و اعلان‌های تلفن همراه.")

Rel(customer, platform,
  "بررسی رستوران‌ها، سفارش می‌دهد، پرداخت می‌کند و تحویل‌ها را ردیابی می‌کند")

Rel(restaurantManager, platform,
  "مدیریت منوها و پردازش سفارشات رستوران")

Rel(deliveryDriver, platform,
  "وظایف تحویل را دریافت می‌کند و وضعیت تحویل را ارسال می‌کند")

Rel(operationsAdmin, platform,
  "نظارت بر عملیات و مدیریت مسائل پشتیبانی")

Rel(platform, paymentProvider,
  "تأیید و دریافت پرداخت‌ها")

Rel(platform, mapService,
  "محاسبه مسیرها و ردیابی مکان تحویل")

Rel(platform, notificationService,
  "ارسال اطلاع‌رسانی‌های سفارش، پرداخت و تحویل")

@enduml

۸. تغییرات رایج در سطح کد اعمال کنید

نام سیستم را تغییر دهید

System(platform, "پلتفرم تحویل غذا",
  "هماهنگی سفارش و تحویل غذا را انجام می‌دهد.")

فرد جدیدی اضافه کنید

Person(customerSupport, "عامل پشتیبانی مشتریان",
  "بررسی مسائل مشتریان و انجام بازپرداخت.")

Rel(customerSupport, platform,
  "بررسی مسائل و مدیریت بازپرداختها")

افزودن یک سیستم خارجی جدید

System_Ext(fraudService, "سرویس تشخیص تقلب",
  "ارزیابی فعالیت‌های پرداخت مشکوک.")

Rel(platform, fraudService,
  "بررسی معاملات پرداخت برای خطر تقلب")

تغییر جهت رابطه

Rel(ارائه‌دهنده پرداخت، پلتفرم،
  "نتایج تأیید و تسویه پرداخت را بازگرداند")

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

تغییر چیدمان

C4-PlantUML از نشانه‌های چیدمان مانند زیر پشتیبانی می‌کند:

LAYOUT_چپ_به_راست()

یا:

LAYOUT_TOP_DOWN()

شما می‌توانید با نشانه‌های جهت‌گیری، بر قرارگیری تأثیر بگذارید:

Lay_R(مشتری، پلتفرم)
Lay_D(پلتفرم، ارائه‌دهنده پرداخت)

از نشانه‌های چیدمان به ندرت استفاده کنید. تعداد زیادی محدودیت دستی می‌تواند نمودار را سخت‌تر برای نگهداری کند.

۹. از کمک هوش مصنوعی VPasCode استفاده کنید

برخی نسخه‌های VPasCode امکان ویرایش نمودار با کمک هوش مصنوعی و اصلاح خطاهای کد را فراهم می‌کنند. این ابزار می‌تواند دستورالعمل‌هایی مانند زیر را بپذیرد:

یک سرویس تشخیص جعل خارجی بین پلتفرم و ارائه‌دهنده پرداخت اضافه کنید.

یا:

خطای سینتکس PlantUML را اصلاح کنید و ساختار نمودار فعلی را حفظ کنید.

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

۱۰. نمودار PlantUML را اعتبارسنجی کنید

قبل از ارسال نمودار به Visual Paradigm Online، هم سینتکس و هم معماری را اعتبارسنجی کنید.

لیست بررسی سینتکس

• اسکریپت با شروع می‌شود@startuml.

• اسکریپت با پایان می‌یابد@enduml.

• کتابخانه C4-PlantUML شامل شده است.

• هر رابطه به شناسه‌های موجود اشاره می‌کند.

• شناسه‌ها شامل فاصله یا علامت‌های نگارشی که می‌توانند سینتکس را خراب کنند، نیستند.

• علامت‌های Angha متعادل هستند.

• توضیحات به طور افراطی طولانی نیستند.

• پیش‌نمایش بدون خطا رندر می‌شود.

لیست بررسی مدل‌سازی C4

• یک سیستم به وضوح شناسایی شده است.

• کاربران به عنوان افراد، نه به عنوان سیستم‌های نرم‌افزاری مدل می‌شوند.

• کاربردهای خارجی به عنوان سیستم‌های خارجی مدل می‌شوند.

• کانتینرها داخلی در یک دیاگرام متن شامل نمی‌شوند.

• روابط تعاملات معنادار را توصیف می‌کنند.

• این نمودار بدون خواندن کد منبع قابل فهم است.

• اصطلاحات با مستندات معماری پروژه هماهنگ است.

مثالی از عنصر نامطلوب در نمودار متناظر

کانتینر(api, "API سفارش", "Java", "سفارشات را پردازش می‌کند")
کانتینرDB(database, "پایگاه داده سفارش", "PostgreSQL", "سفارشات را ذخیره می‌کند")

این‌ها عناصر سطح کانتینر هستند. آن‌ها در یک نمودار کانتینر C4 قرار می‌گیرند، نه به طور معمول در یک نمودار متناظر سیستم.

بخش دوم: نمودار را به Visual Paradigm آنلاین ارسال کنید

۱۱. از «ویرایش در VP آنلاین» یا «ویرایش در نمودار VP آنلاین» استفاده کنید

پس از اینکه نسخه کد صحیح باشد، عملیاتی را که به صورت مشابه برچسب‌گذاری شده است انتخاب کنید:

• ویرایش در VP آنلاین

• ویرایش در دیاگرام VP آنلاین

• باز کردن در آنلاین

• صدور به VP آنلاین

برچسب دقیق ممکن است بسته به نسخه رابط متفاوت باشد.

اکوسیستم Visual Paradigm طراحی شده است تا دیاگرام‌های تولید شده را از چت‌بات هوش مصنوعی به VPasCode برای بهبود سطح کد و سپس به Visual Paradigm آنلاین برای ویرایش سنتی دیاگرام منتقل کند.

ویرایشگر دیاگرام آنلاین زمانی مفید است که به شما نیاز داشته باشید:

• جابجایی شکل‌ها به صورت دستی

• تغییر اندازه عناصر

• تنظیم اتصالات

• تغییر رنگ‌ها و فونت‌ها

• افزودن یادداشت یا توضیحات

• افزودن عنوان یا ا légend

• اعمال فرمت‌بندی ارائه

• هم‌راستایی دقیق عناصر دیاگرام

• نمودار را برای اشتراک‌گذاری یا صدور آماده کنید

۱۲. نمودار را با استفاده از رابط کاربری وبی Visual Paradigm Online ویرایش کنید

هم‌زمان که نمودار در Visual Paradigm Online باز می‌شود:

عناصر را جابه‌جا کنید

افراد و سیستم‌های خارجی را به صورت چیدمان واضحی در اطراف سیستم مرکزی بکشید.

یک چیدمان رایج این است:

• افراد در سمت چپ یا بالا

• سیستم اصلی در وسط

• سیستم‌های خارجی در سمت راست یا پایین

متن را ویرایش کنید

برای ویرایش، روی یک عنصر دوبار کلیک کنید یا صفحه مشخصات آن را انتخاب کنید:

• نام

• توضیحات

• استریوتیپ

• برچسب رابطه

نام‌ها را کوتاه نگه دارید و توضیحات را اطلاع‌بخش نگه دارید.

رابطه‌ها را ویرایش کنید

یک اتصال‌دهنده را انتخاب کنید تا:

• جهت آن را تغییر دهید

• برچسب رابطه را ویرایش کنید

• آن را به عنصر دیگری دوباره متصل کنید

• مسیریابی آن را تنظیم کنید

• سبک خط یا ظاهر آن را تغییر دهید

عناصر اضافه کنید

از پالت نمودار برای افزودن استفاده کنید:

• فرد

• فرد خارجی

• سیستم

• سیستم خارجی

• رابطه

• یادداشت

• مرز

فقط عناصری را اضافه کنید که در سطح متناسب با محتوا قرار دارند.

استایل را اعمال کنید

شما می‌توانید خوانایی را با تنظیم زیر بهبود بخشید:

• اندازه فونت

• رنگ پر کردن

• رنگ حاشیه

• ضخامت خط

• اندازه شکل

• چینش

• فاصله‌گذاری

• مسیریابی اتصال‌دهنده

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

13. طرح‌بندی پیشنهادی ارائه

یک نمودار متناظر تمیز ممکن است از این چینش استفاده کند:

برای نمودارهای بزرگتر:

• سیستم اصلی را در وسط نگه دارید.

• افراد را در یک طرف گروه بندی کنید.

• سیستم‌های نرم‌افزاری خارجی را در طرف دیگر گروه بندی کنید.

• از تقاطع خطوط رابطه خودداری کنید.

• اگر ممکن است برچسب‌های رابطه را افقی نگه دارید.

• به جای پاراگراف‌ها از برچسب‌های کوتاه استفاده کنید.

• فضای کافی را در اطراف سیستم مرکزی باقی بگذارید.

بخش سوم: انتخاب بین ویرایش کد و ویرایش رابط کاربری گرافیکی

VPasCode از مدل‌های C4 از طریق PlantUML پشتیبانی می‌کند و پیش‌نمایش زنده ارائه می‌دهد، در حالی که Visual Paradigm Online جریان کاری سنتی ویژوال برای ویرایش دیاگرام ارائه می‌دهد.

بخش ۴: جریان کار پیشنهادی از ابتدا تا انتها

جریان کار سریع

1. چت‌بات هوش مصنوعی Visual Paradigm را باز کنید.

2. دیاگرام زمینه سیستم C4 را انتخاب کنید.

3. سیستم، کاربران و سیستم‌های خارجی را توصیف کنید.

4. دیاگرام را تولید کنید.

5. از چت‌بات بخواهید جزئیات پیاده‌سازی داخلی را حذف کند.

6. نام‌ها، روابط و دامنه را بررسی کنید.

7. انتخاب کنید در VPasCode باز کنید.

8. منبع C4-PlantUML را ویرایش کنید.

9. نتیجه را رندر کنید و اعتبارسنجی کنید.

10. انتخاب کنید ویرایش در VP آنلاین.

11. با استفاده از رابط کاربری گرافیکی، چیدمان و ظاهر را بهبود بخشید.

12. نمودار نهایی را خارج کنید یا به اشتراک بگذارید.

تقسیم وظایف پیشنهادی

از استفاده کنیدربات چت هوش مصنوعیبرای:

• ایجاد نسخه اولیه

• بررسی گزینه‌های معماری

• افزودن یا حذف شرکت‌کنندگان

• بازنویسی توضیحات روابط

• بررسی نمودار برای اشکالات یا حذف‌ها

از استفاده کنیدVPasCodeبرای:

• تغییر نام بسیاری از عناصر

• استفاده مجدد از کد نمودار

• اعمال ساختار سازگار

• مدیریت کد در کنترل نسخه

• ایجاد تغییرات ساختاری تکرارپذیر

• اصلاح دستورالعمل‌های چیدمان

• تولید منبع حقیقت مبتنی بر متن

استفاده کنید Visual Paradigm Onlineبرای:

• موقعیت‌دهی نهایی بصری

• فرمت‌بندی ارائه

• تنظیم دستی اتصال‌دهنده‌ها

• افزودن یادداشت‌ها و توضیحات

• آماده‌سازی یک نمودار برای ذینفعان

بخش ۵: گفت‌وگوی نمونه بهبود نمودار

درخواست اولیه

یک نمودار محدوده سیستم C4 برای یک پلتفرم تحویل غذا ایجاد کنید.

بهبود ۱

مشتری، مدیر رستوران، راننده تحویل و مدیر عملیات را به عنوان افراد اضافه کنید.

بهبود ۲

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

بهبود ۳

تمام پایگاه‌های داده، APIها، سرویس‌های کوچک، کانتینرها و جزئیات پیاده‌سازی را حذف کنید. این نمودار باید به عنوان یک نمودار سطح ۱ C4 محدوده سیستم باقی بماند.

بهبود ۴

تمام برچسب‌های رابطه را به صورت عبارات فعلی مختصر بازنویسی کنید و در صورت امکان کمتر از ۱۰ کلمه نگه دارید.

بهبود ۵

نمودار را برای روابط گم‌شده و اصطلاحات ناسازگار بررسی کنید. “پلتفرم تحویل غذا” را به عنوان سیستم واحد مورد علاقه حفظ کنید.

بهبود ۶

نمودار را به صورت C4-PlantUML تولید کنید و آن را برای ویرایش در VPasCode در دسترس قرار دهید.

بخش 6: رفع اشکال

نمودار حاوی جزئیات زیادی است

پرسش:

این را به یک نمودار محدوده سیستم C4 ساده کنید. کانتینرها، مؤلفه‌ها، پایگاه‌های داده، APIها و نام‌های فناوری را حذف کنید.

نمودار خطوط تقاطع زیادی دارد

در VPasCode:

• سعی کنید LAYOUT_LEFT_RIGHT() یا LAYOUT_TOP_DOWN().

• محدوده اضافه کنید Lay_ دستورالعمل‌ها.

• برچسب‌های رابطه را کوتاه‌تر کنید.

• تعداد روابط نمایش داده شده را کاهش دهید.

• نسخه نهایی را به VP Online منتقل کنید تا به صورت دستی موقعیت‌گذاری شود.

پیش‌نمایش PlantUML خطایی را نشان می‌دهد

بررسی کنید:

• درگاه کتابخانه C4

• ویرگول‌های گم‌شده

• پرانتزهای باز نشده

• شناسه‌های اشتباه تایپ شده

• رابطه‌هایی که به عناصر تعریف‌نشده اشاره می‌کنند

• علامت‌های Anvār نامتعادل

• نام‌های نادرست عناصر

یک رابطه باید به شناسه‌هایی اشاره کند که قبلاً تعریف شده‌اند، به عنوان مثال:

Person(customer, "مشتری", "سفارش می‌دهد")
System(platform, "پلتفرم تحویل غذا", "سفارشات را پردازش می‌کند")

Rel(customer, platform, "سفارش می‌دهد")

نسخه گرافیکی با نسخه کد متفاوت است

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

• از VPasCode به عنوان منبع حقیقت استفاده کنید اگر نمودار به صورت کد نگهداری شود.

• از Visual Paradigm Online به عنوان منبع حقیقت استفاده کنید اگر ذینفعان به طور مکرر آن را به صورت بصری تنظیم کنند.

از ایجاد تغییرات مرتبط در هر دو مکان بدون همگام‌سازی آنها خودداری کنید.

نمودار تولید شده سطح C4 اشتباهی را استفاده می‌کند

از ربات چت بپرس:

این متن را فقط به عنوان یک نمودار زمینه سیستم C4 بازسازی کن. افراد، سیستم مورد نظر و سیستم‌های نرم‌افزاری خارجی را نشان بده. ظروف یا مؤلفه‌ها را نشان نده.

لیست بررسی نهایی کیفیت

قبل از انتشار نمودار، مطمئن شوید که:

• نمودار عنوان واضحی دارد.

• سیستم مورد نظر واضح است.

• افراد و سیستم‌های خارجی به درستی طبقه‌بندی شده‌اند.

• رابطه‌ها برچسب‌های معنادار دارند.

• هیچ جزئیات پیاده‌سازی داخلی به دیدگاه زمینه نفوذ نکرده است.

• نام‌ها از اصطلاحات سازگار استفاده می‌کنند.

• نمودار در زوم عادی قابل خواندن است.

• خطوط رابطه اشکال یا برچسب‌ها را مسدود نمی‌کنند.

• منبع PlantUML با موفقیت رندر می‌شود.

• نسخه VP Online با معماری تأییدشده مطابقت دارد.

• نمودار نهایی توسط فردی که با سیستم آشناست، بررسی شده است.

کاربرد بهترین روش کار این است که از ربات گفتگوی هوش مصنوعی برای مدلسازی سریع، VPasCode برای ویرایش دقیق و قابل تکرار C4-PlantUML و Visual Paradigm Online برای بهینه‌سازی نهایی بصری استفاده شود. این روش ترکیبی از تولید گفتگویی، قابلیت نگهداری نمودار به عنوان کد و ویرایش ارائه مبتنی بر رابط کاربری گرافیکی را در یک فرآیند ادغام می‌کند.

This post is also available in Deutsch, English, Español, Français, English, Bahasa Indonesia, 日本語, Polski, Portuguese, Ру́сский, Việt Nam, 简体中文 and 繁體中文.