شاهین

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

متوسط
به‌روزرسانی ۲۰ تیر ۱۴۰۵ تحریریه شاهین ۲ دقیقه مطالعه
تلفظEN/ɪˈvɛnt ˌdɑːkjəmɛnˈteɪʃən/

مستندسازی رویداد یعنی نوشتن اینکه هر رویداد چیست، کی فرستاده می‌شود، چه پراپرتی‌هایی دارد و هر مقدار چه معنایی دارد؛ حافظه مشترک تیم درباره داده.

مستندسازی رویداد کم‌جذاب‌ترین و درعین‌حال بازده‌ترین کار حاکمیت داده است، چون بدون آن دانش داده در سر چند نفر می‌ماند و با رفتن‌شان می‌پرد. مستند خوب به یک تحلیلگر تازه اجازه می‌دهد بدون پرسیدن از توسعه‌دهنده بفهمد آیا purchase قبل یا بعد از تایید پرداخت فرستاده می‌شود، و همین یک ابهام می‌تواند تفاوت بین یک عدد درست و یک عدد گمراه‌کننده باشد. مستندسازی بخشی از طرح مفهوم بزرگ‌تری به نام tracking plan است. تله رایج این است که مستند یک بار نوشته و بعد رها می‌شود؛ مستندی که با کد هم‌گام نماند بدتر از نبودنش است، چون به‌غلط اطمینان می‌دهد. برای همین مستندسازی باید کنار خود رویداد و به‌روز نگه داشته شود، نه در فایلی که کسی سراغش نمی‌رود.