پرامپتلی
پرامپت مستندات README

پرامپت مستندات README

۴ بازدید

پرامپت جامع و چندمرحله‌ای برای تولید فایل README استاندارد، حرفه‌ای و آمادهٔ گیت‌هاب؛ شامل ساختار معماری، راهنمای نصب، متغیرها، نمونه‌کدها، پرامپت نسخهٔ سریع و چک‌لیست بازبینی نهایی.

پیش‌نمایش رایگان

رایگان
تو یک مهندس ارشد نرم‌افزار و نویسندهٔ ارشد مستندات فنی (Lead Technical Writer) با تسلط کامل بر استانداردهای متن‌باز و ساختارهای استاندارد گیت‌هاب هستی. وظیفه داری برای پروژه‌ای که اطلاعات آن در ادامه می‌آید، یک فایل README.md بسیار دقیق، مرتب، زیبا و جامع تولید کنی.

## ورودی‌های مورد نیاز
- نام پروژه: {{نام پروژه}}
- شرح مختصر در یک خط: {{شرح یک‌خطی}}
- کارکرد و مسئله‌ای که حل می‌کند: {{هدف و کارکرد اصلی}}
- پشتهٔ فناوری (زبان‌ها، فریم‌ورک‌ها و کتابخانه‌ها): {{فناوری‌های اصلی}}
- پیش‌نیازهای سیستمی: {{پیش‌نیازها و نسخه‌ها}}
- شیوهٔ راه‌اندازی و نصب: {{دستورات نصب}}
- تنظیمات محیطی و متغیرها: {{متغیرهای env}}
- شیوهٔ اجرا و استفادهٔ سریع: {{دستورات اجرا و نمونه کد}}
- نحوهٔ اجرای تست‌ها: {{دستورات تست}}
- ساختار پوشه‌ها و معماری: {{لیست پوشه‌های کلیدی | خودکار بساز}}
- راهنمای مشارکت: {{دارد | ساده | پیشرفته}}
- نوع لایسنس: {{MIT | Apache-2.0 | GPL-3.0 | سایر}}
- لحن متن: {{رسمی و مهندسی | مدرن و مینیمال | آموزشی و شفاف}}
- زبان مستندات: {{فارسی | انگلیسی | دو زبانه}}

## فرآیند کار و مراحل اجرا
این پروسه را در ۴ گام مشخص طی کن و در پایان هر گام منتظر تایید بمان:
گام اول: تحلیل ورودی‌ها و استخراج سرفصل‌ها...

[ادامهٔ فرآیند تعاملی، قوانین کیفیت، دو پرامپت کمکی و چک‌لیست جامع در نسخهٔ کامل آمده است.]

این بخش پیش‌نمایش رایگان است. متن کامل پرامپت پس از خرید در «کتابخانهٔ من» در دسترس شما قرار می‌گیرد.

توضیحات

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

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

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

محتویات این محصول

  • پرامپت تعاملی و چندمرحله‌ای برای تولید README کامل
  • قالب اختصاصی بج‌های گیت‌هاب و معماری ساختار فایل‌ها
  • پرامپت نسخه سریع برای پروژه‌ها و اسکریپت‌های کوچک
  • پرامپت تخصصی بازبینی و ارتقای مستندات موجود
  • راهنمای تنظیم بهینه پرامپت در Claude، ChatGPT و Gemini
  • چک‌لیست ۱۲ مرحله‌ای ارزیابی پیش از انتشار در مخزن

نظرات کاربران

برای ثبت نظر ابتدا وارد شوید.

هنوز نظری برای این محصول ثبت نشده است.

پرسش‌های متداول

این پرامپت برای چه مدل‌هایی مناسب است؟

این محصول برای ChatGPT / GPT، Claude، Gemini ارائه شده است.

بعد از خرید چه چیزی دریافت می‌کنم؟

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

دسترسی به این پرامپت چقدر اعتبار دارد؟

دسترسی به محصول خریداری‌شده دائمی است و از کتابخانه حساب کاربری انجام می‌شود.

محصولات مرتبط

پرامپت نوشتن Regex
وب و بک‌اند

پرامپت نوشتن Regex

پرامپت جامع و مهندسی‌شده برای ساخت عبارات باقاعده (Regex) دقیق، همراه با تشریح جزئیات پترن، جدول تست نمونه‌های مثبت و منفی و کد پیاده‌سازی در زبان دلخواه.

ChatGPT / GPT Claude Gemini
۷۰۰٬۰۰۰ تومان
پرامپت طراحی API رست
وب و بک‌اند

پرامپت طراحی API رست

یک پرامپت جامع و دو نسخه تکمیلی برای طراحی API رست می‌گیرید؛ شامل مدل داده، endpointها، مجوزها و قرارداد خطا، همراه مراحل تأیید، نمونه درخواست و پاسخ، راهنمای استفاده و چک‌لیست کنترل کیفیت.

ChatGPT / GPT Claude Gemini
۳٬۰۰۰٬۰۰۰ تومان
پرامپت معماری بک‌اند مقیاس‌پذیر ٪۱۸ تخفیف
وب و بک‌اند

پرامپت معماری بک‌اند مقیاس‌پذیر

پکیج جامع ۶ پرامپت زنجیره‌ای برای طراحی گام‌به‌گام معماری بک‌اند مقیاس‌پذیر، شامل مدل‌سازی ترافیک، لایه‌بندی کش، صف‌های پیام، مانیتورینگ توزیع‌شده و استراتژی‌های مقاومت‌پذیری در برابر بحران.

ChatGPT / GPT Claude Gemini
۱۲٬۳۰۰٬۰۰۰ تومان ۱۵٬۰۰۰٬۰۰۰ ٪۱۸−