همه محصولات

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

از مسیر واقعی خواننده وارد مستندات شوید و مشخص کنید کدام راهنما قدیمی است، کدام مسیر به جای اشتباه می‌رسد و برای تایید هر ایراد چه مدرکی وجود دارد.

بازبینی مستندات پروژه با هوش مصنوعی از مسیر کسی شروع می‌شود که واقعا می‌خواهد کاری انجام بدهد. مثلا همکار تازه برای تغییر دیتابیس از صفحه راهنما به سندی می‌رسد که فرمانش اجرا می‌شود ولی مربوط به نسخه قبلی است. ابزار بررسی لینک شاید هیچ ایرادی نبیند چون فایل وجود دارد. اسکیل docs-audit کمک می‌کند هم دسترسی به فایل و هم درستی مقصد آن برای کار امروز بررسی شود.

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

کاربردها

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

نصب و استفاده

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

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

منبع

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

مشاهده در GitHub