همه محصولات

نوشتن راهنمای کاربر با هوش مصنوعی

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

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

اسکیل writing-user-docs کمک می‌کنه متن رو از دید کسی بخونید که قراره با محصول کار کنه. اگر مخاطب برنامه‌نویسیه که یک کتابخونه رو نصب می‌کنه، نمونه‌ای می‌خواد که بتونه اجراش کنه. اگر مخاطب کاربر یک وبسایته، واژه‌هایی که در راهنما می‌بینه باید با نوشته‌های روی صفحه جور باشن. جزییات فنی وقتی به متن برمی‌گردن که واقعا روی نتیجه یا انتخاب کاربر اثر داشته باشن.

کاربردها

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

نصب و استفاده

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

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

منبع

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

مشاهده در GitHub