همه محصولات

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

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

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

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

کاربردها

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

نصب و استفاده

  1. بسته رسمی docs-governance و منابع مشترک، مخزن مجاز و دسترسی خواندن راهنماها لازم است. برای بررسی سابقه از Git و برای ابزارهای اختیاری از Python 3 استفاده می‌شود.
  2. مثلا بگویید «طرح مرتب کردن راهنمای سفارش را بده. سند رفتار محصول و توضیح فنی جدا بمانند، ولی خواننده از همان صفحه شروع بداند برای هر سوال کجا برود.»
  3. قبل از جابه‌جایی، طرح را با یک یا دو کار واقعی بررسی کنید و بعد از تغییر مجاز، مسیرهای قدیمی و ارجاع‌ها را دوباره بخوانید.

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

منبع

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

مشاهده در GitHub