docs-guard
نگهدارنده amelnagdy
بازبینی مستندات با docs-guard
- نسخه فعلی
- نامشخص
- مجوز
- نامشخص
- دسترسی شبکه
- نامشخص / ارزیابینشده
- وضعیت بررسی
- تأیید نشده
چه مسئلهای را حل میکند؟
خطا و انحراف مستندات نسبت به source و رفتار واقعی کد را پیش از انتشار آشکار میکند.
چه زمانی مناسب است؟
برای بازبینی README، API reference، docstring، changelog، tutorial یا docs پیش از انتشار استفاده کنید.
مستندات تولیدشده یا تغییرکرده را پیش از انتشار بازبینی میکند: README، API reference، docstring، PHPDoc/JSDoc، changelog، tutorial و doc site. پس از نوشتن یا ویرایش docs توسط ایجنت، مستندسازی تغییر رفتار کد یا پیش از انتشار مناسب است و هر function، flag، endpoint، config key و code sample را با source میسنجد، انحراف docs از code را مییابد و filler یا ادعای غیرقابلراستیآزمایی را حذف میکند. برای production code review، test review، marketing copy، ویرایش نثر غیرفنی یا theming سایت مستندات نیست.
نصب و بهروزرسانی
این دستورها فقط برای کپی نمایش داده میشوند و روی سرور RefHub اجرا نمیشوند. پیش از اجرا، منبع بالادستی پیوندشده را بررسی کنید.
دستور نصب
npx skills add amelnagdy/guard-skills --skill docs-guard -yسازگاری با ایجنتها
هنوز تست سازگاری ثبت نشده است
تا وقتی شواهد تست ثبت نشده، سازگاری این مهارت با ایجنتها را تأییدشده فرض نکنید.