همه محصولات

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

برای کسی که وسط یک کار سراغ مستندات می‌آید راهنما بنویسید. شروع کار، خطاهای رایج و نشانه درست انجام شدن هر مرحله را جایی بگذارید که پیدایش کند.

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

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

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته Arjun Prabhulal. نام اصلی: markdown-docs، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub