همه محصولات

نوشتن فایل README با هوش مصنوعی

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

نوشتن فایل README با هوش مصنوعی وقتی به کار میاد که یک نفر برای اولین بار پروژه رو باز می‌کنه و باید بفهمه این ابزار چیه و چطور می‌تونه امتحانش کنه. اسکیل readme-author فایل‌های واقعی پروژه و نوشته فعلی رو می‌خونه تا معرفی و راه شروع از چیزی بیاد که واقعا وجود داره.

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

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته Gary Gentry. نام اصلی: readme-author، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub