همه محصولات

بازبینی مستندات فنی با هوش مصنوعی

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

بازبینی مستندات فنی با هوش مصنوعی به کارتون میاد وقتی یک راهنما از نظر نگارشی روونه ولی خواننده بعد از انجام دادن قدم سوم، نتیجه‌ای که وعده داده شده رو نمی‌بینه. اسکیل reviewing-technical-prose برای هر ایراد دنبال شاهد می‌گرده. اگر راهنما می‌گه فایل کنار پروژه ذخیره می‌شه، ایجنت باید ببینه مستند یا اجرای تاییدشده هم همون مسیر رو نشون می‌ده.

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

کاربردها

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

نصب و استفاده

  1. مجموعه technical-writer رو در ایجنت‌تون نصب کنید. این اسکیل از راهنمای مشترک همون مجموعه برای بررسی ادعاها و سبک متن استفاده می‌کنه.
  2. نسخه فعلی راهنما، مخاطبش و منبعی رو که اجازه بررسی‌ش هست مشخص کنید. اگر بخشی از متن تایید نهایی شده، از اول بگید.
  3. مثلا بگید «این راهنمای ورود رو از دید کاربر تازه بخون. هرجا اسم گزینه یا نتیجه با مرجع نمی‌خونه، همون جمله و کوچک‌ترین اصلاح لازم رو بده.»
  4. گزارش رو از موارد مهم شروع کنید و برای هر اصلاح ببینید قصد نویسنده و جزییات درست متن حفظ شدن یا نه.

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

منبع

ساخته riekelt. نام اصلی: reviewing-technical-prose، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub