همه محصولات

نوشتن مستند Markdown با ایجنت

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

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

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

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته kaedeasset. نام اصلی: document-authoring، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub