نوشتن سند تصمیم فنی با هوش مصنوعی
دلیل یک انتخاب فنی رو برای همکاری ثبت کنید که ماه بعد به پروژه میرسه. گزینههای بررسیشده، محدودیتها و پیامد انتخاب رو در قالبی بنویسید که تیم میشناسه.
نوشتن سند تصمیم فنی با هوش مصنوعی وقتی ارزشش رو نشون میده که چند ماه بعد کسی میپرسه «چرا گزارشها رو شبانه میسازیم؟» ممکنه در کد معلوم باشه چه ساعتی ساخته میشن، ولی از روی کد نمیشه فهمید تیم گزارش لحظهای رو هم بررسی کرده یا چه محدودیتی باعث شده این زمان رو انتخاب کنه. یک نوشته کوتاه میتونه جلوی تکرار همون بحث رو بگیره.
اسکیل documentation-and-adrs پیش از نوشتن بررسی میکنه آیا تیم برای ثبت این تصمیمها جای مشخص و شیوه نامگذاری داره یا نه. بعد کمک میکنه وضعیت تصمیم، زمینه، راههای دیگه و پیامد انتخاب رو کنار هم نگه دارید. اگر هنوز فقط پیشنهادیه که تیم دربارهاش حرف میزنه، لازم نیست در مستندات شبیه یک تصمیم قطعی دیده بشه.
کاربردها
- یک تصمیم معماری رو با مسئلهای که قرار بوده حل کنه توضیح بدید.
- برای هر گزینه جایگزین بنویسید چرا بررسی شد و چه چیزی به ضررش بود.
- در مستندات پروژه، شماره و جای سند تازه رو با نوشتههای قبلی هماهنگ کنید.
- دلیل انتخاب رو همراه با محدودیتی ثبت کنید که ممکنه در آینده عوض بشه.
- وضعیت پیشنهادی یا پذیرفتهشده تصمیم رو برای خواننده روشن کنید.
نصب و استفاده
- اسکیل رو به ایجنتتون اضافه کنید و نمونه سندهای قبلی، یادداشت بحث و دسترسی مجاز به پروژه رو بدید. برای ثبت فایل، محل موردنظر تیم رو مشخص کنید.
- مثلا بگید «از یادداشتهای جلسه یک سند برای پردازش شبانه گزارشها آماده کنید. گزینه لحظهای و هزینهای رو که باعث شد فعلا کنار بذاریم ثبت کنید. تصمیم هنوز در مرحله پیشنهاده.»
- پیشنویس رو با یکی از آدمهایی که در تصمیم نقش داشته مرور کنید. هر جا معلوم نیست چیزی واقعیت پروژهست یا فرض تیم، قبل از پذیرفته شدن سند اون قسمت رو روشن کنید.
سوالات متداول
منبع
ساخته Addy Osmani. نام اصلی: documentation-and-adrs، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub