همه محصولات

ویرایش مستندات پروژه با هوش مصنوعی

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

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

اسکیل doc-editorial برای همین تصمیم‌های کوچیک یک جای مشخص در پروژه در نظر می‌گیره. ایجنت‌تون می‌تونه نمونه‌ها رو پیدا کنه، یک واژه یا تغییر لحن پیشنهاد بده و انتخاب تیم رو ثبت کنه. دفعه بعد که یک راهنما رو بررسی می‌کنید، می‌تونید از همون تصمیم شروع کنید. برای یک مرور ساده هم لازم نیست اجازه ویرایش همه فایل‌ها رو بدید.

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته Dominik Lukeš. نام اصلی: doc-editorial، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub