توسعه چارچوب مستندسازی Api

1. \[نام پروژه/API] را با نام API خود جایگزین کنید.
2. \[مخاطب هدف] را مطابق با کاربران نهایی مستندات تنظیم کنید.
3. پرامپت را در هر مدل هوش مصنوعی اجرا کنید تا چارچوب کامل مستندسازی تولید شود.
4. خروجی را برای صحت و جامعیت فنی بررسی کنید.
5. از سرفصل‌ها، جدول‌ها و نمونه‌های کد برای افزایش خوانایی استفاده کنید.
6. مثال‌ها و آموزش‌ها را با توجه به سناریوهای واقعی تنظیم کنید.
7. از توضیحات عمومی و کلی خودداری کنید و ویژگی‌ها یا محدودیت‌های خاص API را برجسته کنید.

ایجاد مستندات API ساختاریافته برای تیم‌های داخلی
استانداردسازی مستندات API در محصولات متعدد
تسهیل آموزش توسعه‌دهندگان خارجی و شرکا
ایجاد پایه برای ابزارهای خودکار مستندسازی
مستندسازی APIهای REST، GraphQL یا SOAP
ارائه مثال‌ها و آموزش‌های کدنویسی برای توسعه‌دهندگان
اطمینان از وضوح نسخه‌بندی و مدیریت خطا
کاهش درخواست‌های پشتیبانی با مستندات کامل

مثال‌ها و payloadهای واقعی JSON را وارد کنید
چارچوب را با سطح دانش فنی مخاطب هدف تنظیم کنید
از اصطلاحات یکسان در تمام بخش‌ها استفاده کنید
ویژگی‌های پیچیده یا منحصربه‌فرد API را برجسته کنید
از جدول‌ها و بلوک‌های کد برای خوانایی بهتر استفاده کنید
چارچوب را به‌طور منظم با تغییرات API به‌روزرسانی کنید
مستندات را برای جامعیت و کاربردی بودن تست کنید