توضیح پایگاه‌داده

«توضیح پایگاه‌داده» متن کوتاهی است که به عامل هوشمند می‌گوید این پایگاه‌داده دربارهٔ چیست: حوزهٔ کاری، مفهوم کلی داده‌ها، مهم‌ترین جدول‌ها و اصطلاحاتی که در شرکت شما معنای خاصی دارند. عامل این متن را هنگام پاسخ به هر پرسش می‌خواند. هر اتصال توضیح جداگانهٔ خود را دارد.

چه کسی می‌تواند؟

کاربری که مجوز «مدیریت اتصال‌های پایگاه‌داده» دارد. این متن را بهتر است کسی بنویسد یا بازبینی کند که داده و اصطلاحات کسب‌وکار را می‌شناسد.

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

متن	کجا	دربارهٔ چه
«توضیح شرکت (برای عامل)»	«تنظیمات شرکت»	خود شرکت: صنعت، واحدها، اصطلاحات عمومی
«توضیح پایگاه‌داده»	زبانهٔ «دانش داده» هر اتصال	کل یک پایگاه‌داده: حوزه، جدول‌های اصلی، قواعد کلی
مستندات جدول‌ها	زبانهٔ «دانش داده» هر اتصال	تک‌تک جدول‌ها و ستون‌ها

نوشتن و ذخیرهٔ توضیح

1. «داده و اتصال‌ها» › «اتصال‌های پایگاه‌داده» را باز کنید.
2. روی نام اتصال موردنظر بزنید و زبانهٔ «دانش داده» را باز کنید.
3. در بخش «توضیح پایگاه‌داده» یکی از این دو راه را بروید:
   • متن را خودتان بنویسید؛ یا
   • روی «تولید خودکار توضیحات» بزنید تا عامل ساختار جدول‌ها را بخواند و پیش‌نویسی بنویسد. در این مدت پیام‌هایی مانند «در حال بررسی ساختار جدول‌ها…» نمایش داده می‌شود.
4. پیش‌نویس را بخوانید و اصلاح کنید. پیش‌نویس خودکار از نام جدول‌ها و ستون‌ها حدس می‌زند و قواعد کسب‌وکار شما را نمی‌داند.
5. روی «ذخیرهٔ توضیح» بزنید. پیام «توضیح داده‌ها ذخیره شد» یعنی ذخیره انجام شده است.

اگر پیام «پیشنهاد هوش مصنوعی برای توضیح آماده است» را دیدید، اوبا هنگام مستندسازی متن تازه‌ای پیشنهاد کرده است؛ کنار پیام، زمان پیشنهاد نسبی (مثلاً «۲ ساعت پیش») آمده و تاریخ دقیق با نگه داشتن نشانگر دیده می‌شود. متن فعلی شما خودکار عوض نمی‌شود؛ اگر پیشنهاد را می‌خواهید، «استفاده از پیشنهاد» را بزنید، بازبینی کنید و ذخیره کنید.

نکته

پیش از تولید مستندات جدول‌ها، توضیح پایگاه‌داده را ذخیره کنید. مستندات جدول‌ها با داشتن این زمینه دقیق‌تر نوشته می‌شوند. این توضیح یکی از گام‌های فهرست «راه‌اندازی این اتصال» در زبانهٔ «وضعیت» هم هست.

چه چیزی بنویسید؟

• حوزهٔ کاری: این پایگاه‌داده کدام فعالیت را ثبت می‌کند؟
• جدول‌های اصلی و رابطهٔ آن‌ها: مثلاً «هر ردیف Orders یک سفارش و هر ردیف OrderItems یک قلم کالای سفارش است».
• تعریف معیارهای مهم: «فروش قطعی» یعنی چه؟ مرجوعی و لغو چگونه ثبت می‌شوند؟
• واحدها: مبلغ به ریال است یا تومان؟ وزن به کیلوگرم یا تن؟
• کدها و وضعیت‌ها: مثلاً «Status = 3 یعنی لغوشده».
• بازهٔ زمانی و تازگی داده: داده از چه سالی موجود است و هر چند وقت به‌روز می‌شود؟
• تاریخ: تاریخ‌ها میلادی ذخیره شده‌اند یا شمسی؟

رمز، اطلاعات ورود یا دادهٔ شخصی را در این متن ننویسید.

مثال

این پایگاه‌داده سفارش‌ها، مشتریان و انبار شرکت پخش البرز را از فروردین ۱۴۰۲ نگه می‌دارد و هر شب ساعت ۲ به‌روز می‌شود. هر ردیف Orders یک سفارش است و اقلام آن در OrderItems است. مبالغ به ریال ذخیره شده‌اند. «فروش قطعی» یعنی سفارش‌هایی که Status آن‌ها ۴ (تحویل‌شده) است؛ ۳ یعنی لغوشده. مرجوعی‌ها در جدول Returns ثبت می‌شوند و باید از فروش کم شوند. تاریخ‌ها میلادی‌اند. «منطقه» همان ستون RegionCode است که نام فارسی آن در Regions آمده است.

کیفیت توضیح را بسنجید

پس از ذخیره، یک پرسش شناخته‌شده بپرسید، مثلاً «فروش قطعی شهریور ۱۴۰۵ به تفکیک منطقه چقدر بوده؟»، و نتیجه را با گزارش مرجع شرکت مقایسه کنید. اگر اختلاف دارد، معمولاً تعریف یک معیار یا یک کد وضعیت در توضیح جا افتاده است؛ آن را اضافه کنید.

اشکالات رایج

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

گام بعدی

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