همه محصولات

به‌روزرسانی راهنمای پروژه با هوش مصنوعی

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

به‌روزرسانی راهنمای پروژه با هوش مصنوعی از یک سوال ساده شروع می‌شه. اگر کسی همین امروز قدم‌های راهنما رو انجام بده، هنوز به نتیجه‌ای که نوشته می‌رسه؟ فرض کنید دکمه خروجی گرفتن از بالای جدول به منوی گزارش‌ها منتقل شده. اسکیل docs-maintenance کمک می‌کنه هم راهنمای کاربر رو پیدا کنید، هم جایی که تیم در متن آموزش به مسیر قبلی اشاره کرده.

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

کاربردها

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

نصب و استفاده

  1. مجموعه اصلی docs-governance رو در ایجنت‌تون آماده کنید و دسترسی به پوشه پروژه رو بدید. برای بررسی‌های محلی می‌تونید از Git و پایتون استفاده کنید. نسخه یا تغییری که باید بررسی بشه رو مشخص کنید.
  2. یک نمونه از رفتار تازه و سندی که احتمال می‌دید تحت‌تاثیرش باشه بدید. اگر فقط بررسی می‌خواید، همین رو بگید تا ایجنت اختلاف‌ها رو گزارش کنه.
  3. متن اصلی و ارجاع‌های وابسته رو با هم مرور کنید. اگر اجازه ویرایش دادید، از ایجنت بخواید بعد از اصلاح، نتیجه و موردهای بررسی‌نشده رو جدا بنویسه.

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

منبع

ساخته qshanx. نام اصلی: docs-maintenance، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub