همه محصولات

ساخت وبسایت مستندات پروژه با هوش مصنوعی

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

ساخت وبسایت مستندات پروژه با هوش مصنوعی وقتی به درد می‌خوره که راهنماها رو دارید ولی هرکدوم در یک پوشه‌ست و خواننده نمی‌دونه از کجا باید شروع کنه. اسکیل doc-site اول پروژه و انتخاب‌های قبلی تیم رو بررسی می‌کنه، بعد برای راه‌اندازی با Starlight یا Mintlify فایل‌های لازم رو در همون پروژه می‌سازه.

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

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته Gary Gentry. نام اصلی: doc-site، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub