بازبینی راهنمای نرمافزار با هوش مصنوعی
ببینید کجای یک راهنما خواننده را از کار اصلی دور میکنه و برای همون بخش یک بازنویسی متناسب با موقعیتش بگیرید.
بازبینی راهنمای نرمافزار با هوش مصنوعی از یک پاراگراف شروع میشه. فرض کنید کاربر داره دسترسی یک همکار را تنظیم میکنه و درست وسط مراحل، با توضیح بلند درباره تاریخچه نقشها روبهرو میشه. اسکیل writing-documentation-with-diataxis اول مشخص میکنه الان خواننده دنبال انجام کاره یا میخواد منطق سیستم را بفهمه. بعد میتونید تصمیم بگیرید کدوم توضیح همینجا ضروریه و کدوم را باید به متن دیگهای سپرد.
برای آموزش تازهکارها معیار فرق میکنه. اگر راهنما در قدم اول بین پنج مسیر میذاره، ممکنه قبل از دیدن اولین نتیجه متوقف بشه. ایجنت میتونه پیشنهاد بده مسیر آموزش را کوتاهتر کنید و انتخابهای فرعی را جایی نگه دارید که کاربر بعد از یاد گرفتن اصول بهشون احتیاج پیدا میکنه.
کاربردها
- پیدا کردن متن اضافه در راهنمای عملی، مثل توضیح تاریخی که انجام قدم بعدی را عقب میندازه
- بررسی مسیر آموزش برای وقتی که یک کاربر تازهکار باید بدون تصمیمهای پیچیده به اولین نتیجه برسه
- بازنویسی مرجع تنظیمات تا کاربر باتجربه بتونه یک مقدار یا محدودیت را سریع پیدا کنه
- تشخیص تفاوت بین سوال «چطور انجامش بدم» و «چرا اینطور کار میکنه» در یک صفحه شلوغ
- پیشنهاد اصلاح یک پاراگراف با توضیح اینکه تغییر موردنظر چه مشکلی را برای خواننده حل میکنه
نصب و استفاده
- متن و موقعیت خواننده را به ایجنت بدید. این راهنمای نوشتاری و دو فایل مرجع همراهش با یک ایجنت سازگار کار میکنن و ابزار یا کلید جدا لازم ندارن.
- از ایجنت بخواید یک بخش را انتخاب کنه و بگه خواننده قبل و بعدش چه کاری باید بتونه انجام بده. بعد جملههایی را که هدف دیگهای دارن بررسی کنید.
- نسخه اصلاحشده را با همون موقعیت بخونید. اگر برای فهم موضوع اطلاعات بیشتری لازمه، توضیح را جایی بذارید که خواننده بتونه در وقت مناسب بهش مراجعه کنه.
سوالات متداول
منبع
ساخته Sam McLeod (sammcj). نام اصلی: writing-documentation-with-diataxis، منتشرشده در GitHub با مجوز Apache-2.0.
مشاهده در GitHub