پرش به مطلب اصلی
نسخه: v1.1.0

سند حداقلی BDL

این نمونه کوچک‌ترین ساختار عملی سند BDL را نشان می‌دهد. Schema زبان، هویت پروژه، ظرف مراجع و مجموعهٔ مصنوعات را بدون اختراع وضعیت وابسته به محیط مشخص می‌کند.

نمونه​

{
  "schema": "barsa.definition.v1",
  "project": {
    "code": "SAMPLE",
    "caption": "Sample",
    "systemId": "${RESOLVE_SYSTEM_ID}",
    "version": "1.0.0"
  },
  "references": {},
  "artifacts": []
}

معنی هر بخش​

schema​

خانوادهٔ زبان BDL استفاده‌شده در سند را مشخص می‌کند. مستندات فعلی از barsa.definition.v1 استفاده می‌کنند.

project​

شامل اطلاعات هویت و نسخه در سطح پروژه است. بلوک پروژه باید سیستم موردنظر را بدون ساختن شناسه‌های وابسته به استقرار مشخص کند.

systemId​

این مقدار به محیط وابسته است. در نمونه‌های قابل استفادهٔ مجدد، تا زمان دسترسی به فرادادهٔ معتبر باید تعیین‌نشده بماند. جای‌نگهدار ${RESOLVE_SYSTEM_ID} را با مقدار حدسی جایگزین نکنید.

references​

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

artifacts​

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

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

قواعد تألیف ایمن​

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

ادامه​

نمونهٔ بعدی یک مصنوع موجودیت به این سند حداقلی اضافه می‌کند.