مستندسازی کامپوننت ریاکت با هوش مصنوعی
برای هر کامپوننت توضیح بدید کجا استفاده میشه، چه ورودیهایی میگیره و چه وقت بهتره سراغ گزینه دیگهای برید.
مستندسازی کامپوننت ریاکت با هوش مصنوعی کمک میکنه برای ایجنتتون روشن کنید چرا در یک صفحه از دکمه اصلی استفاده کردید و در صفحه دیگه از یک لینک ساده. اسم و ظاهر کامپوننت به تنهایی جواب این سوال رو نمیده. با اسکیل ai-component-metadata از سورس خودتون شروع میکنید و کنار اطلاعاتی که از کد به دست میاد، کاربرد کامپوننت، نمونه درست و موردی که انتخاب مناسبی نیست رو مینویسید.
فرض کنید در دیزاین سیستمتون دکمهای دارید که موقع ثبت سفارش در حالت انتظار میمونه. علاوه بر اسم اون حالت، میتونید بنویسید چه وقت فعال میشه، کاربر با زدن کلید چه چیزی میبینه و تیم چطور دوباره همین رفتار رو امتحان کنه. نتیجه یک فایل تایپاسکریپت جداست که کنار سورس نگه میدارید و با تغییر کامپوننت بهروز میکنید.
کاربردها
- ورودیهای لازم برای استفاده از یک کامپوننت رو در راهنمای دیزاین سیستم ثبت کنید.
- برای دکمه اصلی و دکمه کماهمیتتر مثالهای جدا بذارید.
- برای یک انتخاب اشتباه، جایگزینی معرفی کنید که واقعا در کتابخانه شما هست.
- رابطه یک قطعه کوچیک با فرم یا منویی که داخلش قرار میگیره رو توضیح بدید.
- رفتار صفحهکلید و جابهجایی تمرکز رو در نمونه واقعی بررسی کنید.
نصب و استفاده
- فایل اصلی کامپوننت رو در پوشه پروژه به ایجنت معرفی کنید. برای ساخت پیشنویس خودکار به پایتون نیاز دارید.
- یک مورد استفاده مشخص بدید. مثلا بخواید دکمه ثبت سفارش در فرم، حالت انتظار و رفتار بعد از ثبت رو در راهنما پوشش بده.
- فایل ساختهشده کنار سورس رو باز کنید. توضیحات نمونه رو با رفتار واقعی عوض کنید و مثال رو در پروژه یا استوریبوک امتحان کنید.
سوالات متداول
منبع
ساخته AI Component Metadata Contributors. نام اصلی: ai-component-metadata، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub