documentation
نگهدارنده mcollina
نگارش و ساختاربندی مستندات فنی با Diátaxis
- نسخه فعلی
- نامشخص
- مجوز
- نامشخص
- دسترسی شبکه
- نامشخص / ارزیابینشده
- وضعیت بررسی
- تأیید نشده
چه مسئلهای را حل میکند؟
نوع و ساختار مناسب مستندات فنی را بر پایهٔ Diátaxis تعیین و تولید میکند.
چه زمانی مناسب است؟
برای نوشتن، بازسازماندهی یا انتخاب نوع مستندات فنی Diátaxis استفاده کنید.
مستندات فنی را با چارچوب Diátaxis میسازد، ساختاربندی و بازبینی میکند: tutorial، how-to guide، reference و explanation. برای نگارش یا سازماندهی docs، انتخاب میان tutorial و how-to، ساخت reference/API doc یا بهبود ساختار مستندات استفاده کنید.
نصب و بهروزرسانی
این دستورها فقط برای کپی نمایش داده میشوند و روی سرور RefHub اجرا نمیشوند. پیش از اجرا، منبع بالادستی پیوندشده را بررسی کنید.
دستور نصب
npx skills add mcollina/skills --skill documentation -yسازگاری با ایجنتها
هنوز تست سازگاری ثبت نشده است
تا وقتی شواهد تست ثبت نشده، سازگاری این مهارت با ایجنتها را تأییدشده فرض نکنید.