همه محصولات

راه‌اندازی Vale برای متن سایت با ایجنت

برای نوشته‌های پروژه یک شیوه‌نامه انتخاب کنید و Vale را روی فایل‌هایی اجرا کنید که خواننده می‌بیند. نتیجه اولین بررسی نشان می‌دهد کدام قواعد واقعا به کارتون می‌آیند.

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

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

کاربردها

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

نصب و استفاده

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

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

منبع

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

مشاهده در GitHub