همه محصولات

اصلاح خطاهای نگارشی Vale با ایجنت

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

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

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

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته Joseph Kato (Vale). نام اصلی: fix، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub