علیرضا اسکندری
دوره کامل وایب کدینگ مقدماتی و پیشرفته اضافه شدثبت‌نام با تخفیف (۴۰٪ تخفیف)

کتابخانه رایگان · پرامپت‌ها

پرامپت: نوشتن AGENTS.md برای پروژه با کمک ایجنت

۱۱ آبان ۱۴۰۵

یه پرامپت آماده که ایجنت خودش کد رو بگرده و یه AGENTS.md کوتاه و به‌دردبخور بنویسه؛ دستورهای تست، قراردادها و خط قرمزها، بدون توضیح اضافه.

پرامپت: نوشتن AGENTS.md برای پروژه با کمک ایجنت

هر بار یه جلسه‌ی تازه با ایجنت باز می‌کنی و باید بگی تست‌ها با چی اجرا میشن و به فلان پوشه دست نزنه؟ جای این حرف‌ها یه فایله: AGENTS.md.

AGENTS.md یه فرمت باز و ساده‌ست؛ یه فایل مارک‌داون توی ریشه‌ی پروژه که ایجنت‌های کدنویسی اول کار می‌خونن. طبق مستندات Codex، Codex قبل از شروع کار این فایل رو می‌خونه. Claude Code هم فایل CLAUDE.md خودش رو داره که می‌تونی داخلش به AGENTS.md ارجاع بدی.

مشکل اینجاست که بیشتر آدم‌ها یا اصلاً نمی‌نویسنش، یا یه فایل ۳۰۰ خطی می‌نویسن که نصفش توضیح ساختار پوشه‌هاست. این پرامپت کمک می‌کنه نسخه‌ی کوتاه و درستش رو بگیری.

پرامپت رو کپی کن:

«می‌خوام برای این پروژه یه فایل AGENTS.md بنویسی که هر ایجنت کدنویسی (Codex، Claude Code، Cursor و بقیه) اول کار بخونه. قبل از نوشتن، خودت کد رو بگرد: package.json یا فایل‌های مشابه، اسکریپت‌ها، تنظیمات تست و لینت، CI و README. فقط چیزهایی رو بنویس که ایجنت با خوندن کد سریع نمی‌فهمه یا هر بار باید از اول کشفش کنه. معماری و ساختار پوشه‌ها رو توضیح نده، خودش می‌خونه. این بخش‌ها رو داشته باشه: ۱) دستورهای دقیق نصب، اجرا، تست کل پروژه، تست یک فایل، لینت و تایپ‌چک؛ ۲) قراردادهایی که از کد معلوم نیستن یا کد قدیمی خلافشونه (مثلاً «پوشه‌ی legacy هنوز زنده‌ست ولی ازش الگو نگیر»)؛ ۳) چیزهایی که ایجنت هیچ‌وقت نباید بکنه (فایل‌های تولیدشده، migrationها، کلیدها و فایل env)؛ ۴) تعریف «تموم شد»: چه چک‌هایی باید پاس بشن. کل فایل زیر ۶۰ خط باشه و جمله‌ها کوتاه. هر جا مطمئن نیستی، حدس نزن؛ آخر کار یه لیست سؤال بهم بده تا جوابشون رو بدم و فایل رو کامل کنی.»

بعدش چیکار کنی؟

این اصل «فقط چیزی رو بنویس که ایجنت نمی‌بینه» رو از راهنمای بهترین روش‌های Claude Code گرفتم. اگه می‌خوای چند قانون رفتاری خوب هم اضافه کنی، قوانین کارپاتی برای ایجنت کدنویس رو ببین. برای کارهای تکراری چندمرحله‌ای هم به جای AGENTS.md یه اسکیل بساز؛ پرامپت تبدیل کار تکراری به اسکیل برای همینه. اگه هم هنوز Codex رو نصب نکردی، معرفی Codex CLI رو بخون.

هر چی رو دو بار توضیح دادی، یه بار بنویس.

  1. سؤال‌هایی که آخر کار می‌پرسه رو جواب بده؛ معمولاً همون‌ها مهم‌ترین بخش فایلن.
  2. فایل رو بخون و هر خطی که ایجنت خودش از کد می‌فهمه رو پاک کن.
  3. هر بار که یه چیز رو دو بار به ایجنت تذکر دادی، یه خط بهش اضافه کن.
پرامپت: نوشتن AGENTS.md برای پروژه با کمک ایجنت | علیرضا اسکندری