این پوشه مرکز مستندات Markdown پروژه امیر است. برای هماهنگی زبانها، README فارسی بدون پیشوند
نگهداری میشود و نسخه انگلیسی همان فایل با نام README.en.md قرار میگیرد.
مسیرهای اصلی
| مسیر | مخاطب | توضیح |
|---|---|---|
| راهنمای استفاده کنندگان | کاربران غیرتوسعهدهنده | عملیات روزمره، حضور و غیاب، حقوق و دستمزد، موجودی کالا و سال مالی |
| مفاهیم حسابداری | کاربران و توسعهدهندگان | مفاهیم حسابداری، بهای تمامشده، برگشت از خرید/فروش و سال مالی |
| راهنمای برنامهنویس | توسعهدهندگان | معماری پروژه، دیتابیس، تست و اسکریپتها |
| راهنمای نصب | مدیر سیستم و توسعهدهنده | نصب با Docker Compose، Docker تکدستوری یا نصب استاندارد |
| سال مالی | همه کاربران | تعریف سال مالی و راهنمای ایجاد آن در امیر |
| خروجی/ورودی سال مالی | مدیر سیستم و توسعهدهنده | دستورهای fiscal-year:export و fiscal-year:import |
همه فایلهای مستندات
| فایل | دسته | توضیح |
|---|---|---|
| INSTALLATION / EN | نصب | راهنمای نصب فارسی و انگلیسی |
| user/README / EN | کاربر عادی | فهرست ثانویه مستندات کاربردی و حسابداری |
| accounting/README / EN | حسابداری | فهرست مفاهیم حسابداری |
| developer/README / EN | برنامهنویس | فهرست ثانویه مستندات فنی |
| user/attendance/README / EN | حضور و غیاب | راهنمای کار با شیفت، لاگ و کارکرد ماهانه |
| user/salary/README / EN | حقوق و دستمزد | راهنمای عوامل حقوقی، احکام و فیش حقوقی |
| user/inventory-costing / EN | حسابداری کالا | بهای تمامشده، روشهای محاسبه و روش مورد استفاده امیر |
| fiscal-year / EN | سال مالی | مفهوم سال مالی و ایجاد آن |
| FiscalYearExportImport | سال مالی | خروجی گرفتن و وارد کردن داده سال مالی |
| accounting-basics | حسابداری | مبانی حسابداری، بدهکار، بستانکار و سند |
| return-sell-return-buy | حسابداری کالا | برگشت از فروش و برگشت از خرید |
| project-structure | فنی | ساختار پروژه Laravel |
| database-guide | فنی | ساختار پایگاه داده و روابط |
| testing-guide | فنی | راهنمای تستنویسی و اجرای تست |
| script/README | ابزارها | مستندات اسکریپتهای مهاجرت و داده |
نگهداری مستندات
- هر README فارسی باید با README انگلیسی متناظر از نظر ساختار و لینکها همگام بماند.
- اگر فایل جدیدی به
docs/یا پوشههای زیرمجموعه اضافه شد، آن را در این فهرست یا یکی از دو فهرست ثانویه ثبت کنید. - اگر مستندی برای کاربران عادی قابل استفاده است، آن را در user/README هم معرفی کنید.
- اگر مستندی برای توسعه یا ساختار داخلی پروژه است، آن را در developer/README هم معرفی کنید.