Lore
Lore یک کارخانهی مستندسازی محصولمحور و قابل استفادهی مجدد است که بهشکل یک پلاگین Claude Code بستهبندی شده است. آن را در هر مخزن مستنداتی نصب کنید تا همان اسکیلهای نگارش، ساباجنتهای بازبینی و هوکهای کنترلی بازدارنده را داشته باشید: یکبار نگهداری میشود و همهجا استفاده.
:::info پایدار Lore از نسخهبندی معنایی پیروی میکند: تغییر شکننده در دستورها، قالبها یا قراردادها فقط در یک انتشار major میآید. برای ثابتکردن یک تگ مشخص، نسخهبندی را ببینید. :::
مسئلهای که حل میکند
صفحهها تغییر میکنند، بریفها جابهجا میشوند و محصول زنده جلو میرود، و مستندات بیسروصدا عقب میمانند. بیشتر تیمها قواعد نگارش، مراحل بازبینی و قراردادهای پوشهبندی خود را در هر مخزن از صفر اختراع میکنند.
Lore کل این متدولوژی را یکبار بستهبندی میکند. پلاگین را نصب کنید و هر مخزن همان اسکیلها، همان «تعریف انجامشدن» و همان حفاظها را به ارث میبرد. یکبار چیزی را در پلاگین اصلاح کنید و هر مخزن با یک بهروزرسانی ساده آن تغییر را میگیرد.
سه راه نگارش
از هر ورودیای که همین حالا دارید شروع کنید. هر مسیر یک اسکیل راهنماست که منبع را میخواند، سؤالهای درست را میپرسد و مستندات ساختارمند مینویسد.
| منبع | اسکیل | چه زمانی |
|---|---|---|
| طراحی Figma | lore:figma-to-doc | فایلهای طراحی، ماکآپ یا حاشیهنویسی دارید |
| بریف یا PRD | lore:brief-to-doc | الزامات نوشتهشده یا یوزر استوری دارید |
| محصول زنده | lore:site-to-doc | میخواهید رفتار واقعی محصول را مستند کنید |
پیش از تحویل، نتیجه را با lore:doc-reviewer در برابر تعریف انجامشدن اعتبارسنجی کنید.
چطور کنار هم مینشیند
Lore فقط متدولوژی محصولمحور را حمل میکند. هر چیز مخصوص محصول، یعنی منابع مورد اعتماد، نقشهای کاربری، ساختار سند و زبان، در پیکربندی خود مخزن مصرفکننده میماند. همین تقسیم مسئولیت است که میگذارد یک مجموعه اسکیل به همهی محصولها خدمت کند.
یک ویوئر اختیاری Docusaurus این Markdown را به یک سایت قابلمرور و چندزبانه و آمادهی RTL تبدیل میکند؛ همان موتوری که مستنداتی را که اکنون میخوانید میسازد.
قدم بعدی کجاست
- تازهواردید؟ با نصب شروع کنید، سپس شروع سریع.
- مفاهیم را میخواهید؟ تقسیم مسئولیت و تعریف انجامشدن را بخوانید.
- دنبال چیزی میگردید؟ به مرجع بروید.