ویرایش راهنمای فنی با هوش مصنوعی
یک صفحه راهنما رو از نظر جملهبندی، عنوانها، مثالهای کد و منبع ارجاع بررسی کنید. برای هر ایراد یک تغییر مشخص بگیرید که خودتون بتونید دربارهش تصمیم بگیرید.
ویرایش راهنمای فنی با هوش مصنوعی وقتی مفیده که مطلب از نظر تیم آمادهست، اما خواننده برای پیدا کردن یک دستور یا فهمیدن اینکه چه کسی باید کاری انجام بده معطل میشه. اسکیل docs-helper متن موجود رو با چند قاعده مشخص میخونه و پیشنهاد میده کدوم عبارت، عنوان یا مثال بهتره عوض بشه.
مثلا ممکنه نوشته باشید «فایل تنظیمات باید ایجاد شود» و خواننده ندونه خودش باید فایل رو بسازه یا برنامه براش میسازه. میتونید بخواید همین جمله روشن بشه و بقیه بند سر جاش بمونه. اگر از روی متن معلوم نیست کدوم برداشت درسته، اطلاعات واقعی پروژه رو در اختیار ایجنتتون بذارید تا ویرایش از یک حدس فنی شروع نشه.
کاربردها
- برای ویرایش مستندات پروژه، جملههایی رو پیدا کنید که انجامدهنده کار در اونها معلوم نیست.
- ساختار عنوانها رو بررسی کنید تا صفحه فقط یک عنوان اصلی داشته باشه و بخشهای بعدی زیر اون قرار بگیرن.
- مثال کد رو ببینید و برای قطعههایی که زبانشون مشخص نیست برچسب مناسب بگذارید.
- برای اصلاح راهنمای نصب، نشون بدید خواننده از یک مثال واقعی چه چیزی باید بنویسه یا انتظار داشته باشه.
- ارجاع به منبع اصلی رو بررسی کنید تا بخش مرجع، خواننده رو به نسخه کپی یا قدیمی نفرسته.
نصب و استفاده
- اسکیل رو نصب کنید و مسیر یک فایل راهنما یا متن مورد تایید رو به ایجنتتون بدید. برای بررسی نوشته محلی حساب جدا لازم نیست.
- بگید «صفحه نصب رو مرور کن. سه جملهای رو که کاربر ممکنه ازشون برداشت اشتباه داشته باشه پیدا کن و تغییر پیشنهادی رو کنار هر کدوم بنویس.»
- تغییرها رو موردبهمورد بخونید. اگر یک دستور به نسخه خاصی از برنامه مربوطه، قبل از پذیرفتن متن تازه اون رو با واقعیت پروژه تطبیق بدید.
سوالات متداول
منبع
ساخته Gary Gentry. نام اصلی: docs-helper، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub