همه محصولات

نوشتن راهنمای پروژه برای ایجنت

تصمیم‌ها و قاعده‌های خاص پروژه را در یک فایل مرجع جمع کنید تا ایجنت بعدی بداند از کجا شروع کند و چه چیزی را باید پیش از تغییر بررسی کند.

نوشتن راهنمای پروژه برای ایجنت وقتی ارزش دارد که چیزی را ثبت کنید که از روی نام پوشه‌ها نمی‌شود فهمید. شاید صفحه فروش و پنل در یک مخزن باشند ولی هر کدام روی یک میزبان جدا اجرا شوند. کسی که این تصمیم را نمی‌داند ممکن است تغییر درستی بنویسد و آن را در جای اشتباه آزمایش کند. اسکیل project-memory کمک می‌کند این جور دانستنی‌ها را از توضیح‌های کلی جدا کنید.

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

کاربردها

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

نصب و استفاده

  1. یک ایجنت با دسترسی مجاز به فایل‌های پروژه و راهنمای موجود لازم دارید. استفاده از پیگیری مشترک در GitHub اختیاری است و به اجازه همان مخزن نیاز دارد.
  2. مثلا بگویید «از این یادداشت‌ها یک راهنمای کوتاه بساز. فقط تصمیم‌هایی را نگه دار که روی اجرا یا تحویل اثر دارند و فایل‌های تکراری را مشخص کن.»
  3. متن را با یک کار واقعی امتحان کنید و اگر ایجنت هنوز باید درباره یک مرحله حدس بزند، نشانه یا فرمان دقیق‌تری اضافه کنید.

سوالات متداول

منبع

ساخته Joe Amditis. نام اصلی: project-memory، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub