پرامپت‌نویسی برای برنامه‌نویسان؛ ۲۵ پرامپت کاربردی برای کدنویسی

⚡ پاسخ کوتاه

پرامپت خوب برنامه‌نویسی پنج جزء دارد: نقش، زمینهٔ پروژه، وظیفهٔ دقیق، محدودیت‌ها و قالب خروجی. نسخهٔ زبان، فریم‌ورک، کد مرتبط و خطای کامل را بدهید، دلیل خواسته‌تان را بگویید، اول نقشه بخواهید و بعد کد، و همیشه تست و بازبینی امنیتی را جزو درخواست بگذارید. ۲۵ پرامپت آمادهٔ این مقاله برای نوشتن کد، دیباگ، تست، ریفکتور و مستندسازی دسته‌بندی شده‌اند.

📑 فهرست مطالب

1. چرا پرامپت در کدنویسی این‌قدر مهم است؟
2. ۵ اصل پرامپت‌نویسی برای برنامه‌نویس‌ها
3. پرامپت‌های نوشتن کد جدید
4. پرامپت‌های دیباگ و رفع خطا
5. پرامپت‌های تست‌نویسی
6. پرامپت‌های ریفکتور و بازبینی کد
7. پرامپت‌های مستندسازی و توضیح کد
8. پرامپت‌های تخصصی Python، Django و Java
9. اشتباهات رایج در پرامپت‌نویسی برنامه‌نویسی
10. سؤالات متداول
    • پرامپت را فارسی بنویسم یا انگلیسی؟
    • کدام مدل برای این پرامپت‌ها بهتر است؟
    • چقدر کد در پرامپت بگذارم؟
    • چرا مدل کدی می‌دهد که اجرا نمی‌شود؟
    • کد تولیدشده با هوش مصنوعی امن است؟
11. منابع و مراجع

قالب پایه

نقش: تو یک برنامه‌نویس ارشد [Python/Django] هستی. زمینه: پروژهٔ من [توضیح کوتاه] است؛ نسخه‌ها: [Python 3.12، Django 5.x، PostgreSQL]. <code> [کد مرتبط] </code> وظیفه: [دقیقاً چه می‌خواهید]. محدودیت‌ها: کتابخانهٔ جدید اضافه نکن، با سبک کد موجود هماهنگ باش، مقدارها را hard-code نکن. خروجی: اول نقشهٔ کوتاه، بعد کد کامل، بعد فهرست تست‌هایی که باید اجرا کنم.

پرامپت ۱ — اول نقشه، بعد کد

می‌خواهم [قابلیت] را به پروژه اضافه کنم. هنوز کد ننویس. اول فایل‌هایی که باید تغییر کنند، مراحل کار و ریسک‌ها را فهرست کن. بعد از تأیید من، کد را بنویس.

پرامپت ۲ — ساخت API در Django

در Django 5 و Django REST Framework یک endpoint برای [مدل] بساز: لیست با صفحه‌بندی، فیلتر بر اساس [فیلد]، و دسترسی فقط برای کاربر واردشده. serializer، view و url را جدا بنویس و برای هر کدام توضیح یک‌خطی بده.

پرامپت ۳ — تابع با شرط‌های مرزی

یک تابع Python بنویس که [کار]. ورودی‌های نامعتبر، لیست خالی و مقدار None را مدیریت کن. type hint و docstring بگذار و در آخر ۵ ورودی مرزی را که باید تست کنم نام ببر.

پرامپت ۴ — کلاس Java با اصول SOLID

یک کلاس Java 21 برای [کار] بنویس که اصل Single Responsibility را رعایت کند. وابستگی‌ها را از طریق constructor تزریق کن تا قابل تست باشد. اگر طراحی بهتری سراغ داری، قبل از کد پیشنهاد بده.

پرامپت ۵ — کوئری بهینهٔ دیتابیس

این کوئری ORM کند است: <code>[کد]</code> جدول [نام] حدود [تعداد] ردیف دارد. مشکل N+1 یا ایندکس‌های لازم را پیدا کن و نسخهٔ بهینه را با select_related یا prefetch_related بنویس. دلیل هر تغییر را بگو.

پرامپت ۶ — تبدیل توضیح به کد

این نیازمندی کسب‌وکار را به کد تبدیل کن: «[نیازمندی به زبان ساده]». اگر جایی مبهم است، قبل از نوشتن کد حداکثر ۳ سؤال بپرس.

پرامپت ۷ — تحلیل traceback

این خطا را می‌گیرم: <error>[traceback کامل]</error> <code>[تابع مرتبط]</code> انتظار داشتم [رفتار درست]. سه علت محتمل را به ترتیب احتمال بگو و برای هر کدام یک راه بررسی بده. هنوز کد را تغییر نده.

پرامپت ۸ — باگ بدون خطا

این تابع خطا نمی‌دهد ولی خروجی‌اش برای ورودی [مثال] اشتباه است: [خروجی فعلی] به‌جای [خروجی درست]. خط‌به‌خط اجرا را دنبال کن و نقطه‌ای را که منطق خراب می‌شود نشان بده.

پرامپت ۹ — اضافه کردن لاگ هوشمند

نمی‌دانم این باگ کجا رخ می‌دهد. پیشنهاد بده در کدام نقاط این کد لاگ بگذارم و دقیقاً چه متغیرهایی را چاپ کنم تا علت پیدا شود. از ماژول logging استفاده کن، نه print.

پرامپت ۱۰ — مشکل همزمانی

این کد گاهی (نه همیشه) نتیجهٔ اشتباه می‌دهد و حدس می‌زنم race condition باشد. سناریوهایی را که دو درخواست هم‌زمان باعث خرابی می‌شوند توضیح بده و راه‌حل با transaction یا قفل دیتابیس پیشنهاد کن.

پرامپت ۱۱ — خطای بعد از ارتقای نسخه

بعد از ارتقای [کتابخانه] از نسخهٔ [قدیم] به [جدید] این خطا آمده: [خطا]. تغییرات ناسازگار (breaking changes) محتمل را بگو. اگر از تغییرات این نسخه مطمئن نیستی، صریحاً بگو تا خودم changelog را چک کنم.

پرامپت ۱۲ — تست واحد کامل

برای این تابع با pytest تست بنویس: حالت عادی، ورودی‌های مرزی، ورودی نامعتبر و استثناها. هر تست یک چیز را بسنجد و نامش بگوید چه چیزی را تست می‌کند.

پرامپت ۱۳ — تست برای کد قدیمی

این کد تست ندارد و می‌خواهم ریفکتورش کنم. اول تست‌هایی بنویس که رفتار فعلی را ثابت کنند (characterization tests)، حتی اگر رفتار فعلی عجیب باشد.

پرامپت ۱۴ — تست ویو در Django

برای این view تست Django بنویس: کاربر مهمان باید ریدایرکت شود، کاربر عادی ۴۰۳ بگیرد و ادمین ۲۰۰. از TestCase و client خود Django استفاده کن و داده را با setUpTestData بساز.

پرامپت ۱۵ — پیدا کردن حالت‌های جاافتاده

این تست‌ها را ببین: <tests>[تست‌ها]</tests> چه سناریوهایی پوشش داده نشده‌اند؟ فقط فهرست بده و بگو کدام مهم‌تر است.

پرامپت ۱۶ — ریفکتور بدون تغییر رفتار

این تابع را خواناتر کن بدون اینکه رفتارش عوض شود. تابع‌های بلند را بشکن، نام‌ها را گویا کن و تکرار را حذف کن. تغییرات را به‌صورت فهرست توضیح بده.

پرامپت ۱۷ — بازبینی مثل یک ارشد

مثل یک بازبین سخت‌گیر این Pull Request را بررسی کن. مشکلات را در سه دسته بگو: باگ، امنیت، خوانایی. برای هر مورد شمارهٔ خط و پیشنهاد اصلاح بده. تعریف و تمجید لازم نیست.

پرامپت ۱۸ — بازبینی امنیتی

این کد را از نظر OWASP Top 10 بررسی کن: SQL Injection، XSS، احراز هویت ناقص، افشای اطلاعات حساس و ورودی‌های بدون اعتبارسنجی. برای هر مشکل، نسخهٔ امن را بنویس.

پرامپت ۱۹ — Clean Code

این کد را بر اساس اصول Clean Code بازنویسی کن و بگو کدام اصل را کجا اعمال کردی.

پرامپت ۲۰ — README پروژه

بر اساس این ساختار پوشه و فایل settings، یک README بنویس: هدف پروژه، پیش‌نیازها، نصب، اجرای محلی، متغیرهای محیطی و اجرای تست. فرض نکن چیزی را که در کد نیست.

پرامپت ۲۱ — توضیح کد ناآشنا

این کد را برای برنامه‌نویسی توضیح بده که تازه وارد تیم شده: اول هدف کلی در دو جمله، بعد جریان داده قدم‌به‌قدم، و در آخر بخش‌هایی که احتمالاً شکننده‌اند.

پرامپت ۲۲ — docstring و کامنت

برای همهٔ تابع‌های عمومی این ماژول docstring به سبک Google بنویس. کامنت درون‌خطی فقط جایی بگذار که «چرا» را توضیح می‌دهد، نه «چه» را.

پرامپت ۲۳ — مهاجرت دیتابیس امن

می‌خواهم فیلد [نام] را از [نوع] به [نوع] تغییر دهم و جدول حدود [تعداد] ردیف دارد. migrationهای Django را طوری بنویس که داده از بین نرود و سایت هنگام اجرا از دسترس خارج نشود. مراحل را جدا کن.

پرامپت ۲۴ — تبدیل اسکریپت به کار پس‌زمینه

این اسکریپت Python را به یک تسک Celery تبدیل کن: retry با تأخیر افزایشی، timeout، لاگ خطا و idempotent بودن را رعایت کن.

پرامپت ۲۵ — مهاجرت Java به نسخهٔ جدید

این کلاس با Java 8 نوشته شده. آن را با امکانات Java 21 (record، switch expression، var و Stream) به‌روز کن، ولی فقط جایی که خوانایی را واقعاً بهتر می‌کند.

همه منابع در تاریخ ۹ آبان ۱۴۰۵ بررسی شده‌اند.

1. Anthropic — Prompt engineering overview
2. Anthropic — Prompting best practices
3. OpenAI — Prompt engineering guide
4. Prompt Engineering Guide (DAIR.AI)
5. OWASP Top 10
6. Django documentation