همه محصولات

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

از نمونه‌های واقعی پروژه بفهمید تیم چطور فایل‌ها را می‌چیند، اسم می‌گذارد و تست می‌نویسد. حاصل کار یک راهنمای Markdown برای همان پروژه است.

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

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

کاربردها

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

نصب و استفاده

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

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

منبع

ساخته Michael Boeding. نام اصلی: style-guide، منتشرشده در GitHub با مجوز MIT.

مشاهده در GitHub