ساختاردهی مستندات فنی با هوش مصنوعی
صفحههای راهنما را بر اساس کاری که خواننده به خاطرش سراغشون میاد مرتب کنید و برای هر صفحه شکل مناسبی انتخاب کنید.
ساختاردهی مستندات فنی با هوش مصنوعی وقتی به کار میاد که همه اطلاعات در سایت هست، ولی کاربر برای پیدا کردن یک گزینه باید از نصف یک آموزش بگذره. اسکیل documentation از شما میپرسه خواننده کیه و در این لحظه دنبال چه چیزیه. کسی که برای اولین بار یک ابزار را باز کرده، با همکاری که فقط مقدار پیشفرض یک تنظیم را میخواد یک مسیر لازم نداره.
مثلا در راهنمای یک برنامه گزارشگیری ممکنه نصب، ساخت اولین گزارش و جدول ستونهای قابل خروجی کنار هم اومده باشن. با این اسکیل میتونید تجربه اول را به یک آموزش قابل دنبال کردن تبدیل کنید، تنظیمات را در مرجع نگه دارید و نحوه گرفتن یک خروجی مشخص را در یک صفحه کوتاه جدا بنویسید. بین صفحهها هم جایی لینک میذارید که واقعا به خواننده کمک کنه.
کاربردها
- مرتب کردن راهنمای کاربر وقتی مراحل شروع، تنظیمات و توضیحهای مفهومی در یک صفحه جمع شدن
- ساخت آموزش قدمبهقدم برای کسی که میخواد اولین بار یک کار مشخص را با موفقیت انجام بده
- جدا کردن راهنمای انجام کار از جزییات اضافهای که خواننده باتجربه برای رسیدن به نتیجه لازم نداره
- طراحی صفحه مرجع برای پیدا کردن سریع یک گزینه، مقدار پیشفرض یا ورودی مجاز
- مشخص کردن جای توضیح مفهومی برای وقتی که خواننده میخواد دلیل یک تصمیم یا محدودیت را بفهمه
نصب و استفاده
- متن موجود یا فهرست صفحهها و یک نمونه سوال واقعی کاربر را به ایجنت بدید. برای بررسی ساختار، حساب جدا یا دسترسی انتشار لازم نیست.
- بگید خواننده تازهکاره یا تجربه داره و دنبال انجام کاره یا فهمیدن موضوع. بعد نقش هر صفحه را مشخص کنید و مطالب نامرتبط با اون نقش را کنار بذارید.
- طرح تازه را با یک سوال واقعی امتحان کنید. ببینید خواننده چطور از صفحه اول به جواب میرسه و اگر لازم بود کجا میتونه اطلاعات بیشتر بخونه.
سوالات متداول
منبع
ساخته Matteo Collina. نام اصلی: documentation، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub