docs(sdlc): reformat work products to audited reference layout
Replace the PHP/Markdown seeding with a data-driven generator in scripts/sdlc-seed and regenerate all 59 work products.
This commit is contained in:
Thanakorn
+121
@@ -0,0 +1,121 @@
|
||||
# Software User Document
|
||||
|
||||
<!-- footer: SuD -->
|
||||
|
||||
| Document No | Software User Document | Release, Version, By: | 25690814 V1.0 ThS |
|
||||
| Project Name | โครงการพัฒนาระบบบริหารจัดการคลังสินค้า (BRN WMS) บริษัท บี.อาร์.เอ็น เอ็นเตอร์ไพรส์ จำกัด |
|
||||
| Project Code | 200-WMS-26-001-00 |
|
||||
| Title | เอกสารคู่มือการใช้งานสำหรับผู้ใช้ |
|
||||
| Project Period | 5 มกราคม 2569 – 24 สิงหาคม 2569 |
|
||||
| Organizer | คุณอภิรัชช์ สุภัทรประทีป (Project Manager) , คุณนพพงษ์ เจริญสุข (System Analyst) |
|
||||
| Recorder | คุณเยาวลักษณ์ บางชมภู (Document Control) |
|
||||
|
||||
## วัตถุประสงค์ (Objective)
|
||||
|
||||
คู่มือฉบับนี้จัดทำขึ้นเพื่อเป็นแนวทางสำหรับผู้ใช้งานระบบบริหารจัดการคลังสินค้า ครอบคลุมการเข้าสู่ระบบ การตั้งค่าข้อมูลหลัก การบันทึกรายการคลังสินค้า งานขาย งานจัดซื้อ งานการเงินและบัญชี การเรียกดูรายงาน และการรับการแจ้งเตือน
|
||||
|
||||
## 1 การเข้าสู่ระบบ (System Access)
|
||||
|
||||
| ลำดับ | รายละเอียด |
|
||||
| :---: | --- |
|
||||
| 1 | เข้าใช้งานผ่าน Web Browser มาตรฐาน (Chrome, Edge, Firefox) ตาม URL ที่ผู้ดูแลระบบกำหนด |
|
||||
| 2 | ผู้ใช้งานใหม่ที่เป็นเจ้าของบริษัทให้เลือก "ลงทะเบียนบริษัท" และยืนยันอีเมลเพื่อเปิดใช้งาน |
|
||||
| 3 | ผู้ใช้งานที่ได้รับคำเชิญให้กดลิงก์ในอีเมลเชิญ แล้วตั้งรหัสผ่านเพื่อเข้าร่วมบริษัท |
|
||||
| 4 | กรณีลืมรหัสผ่าน ให้เลือก "ลืมรหัสผ่าน" ระบบจะส่งลิงก์และรหัส OTP ไปยังอีเมลที่ลงทะเบียนไว้ |
|
||||
| 5 | ระบบอนุญาตให้ใช้งานได้ครั้งละหนึ่ง Session ต่อบัญชี หากเข้าสู่ระบบจากอุปกรณ์ใหม่ระบบจะปฏิเสธการเข้าใช้งานซ้ำ |
|
||||
| 6 | หน้าจอรองรับการใช้งานบนคอมพิวเตอร์ แท็บเล็ต และโทรศัพท์มือถือ |
|
||||
|
||||
## 2 บทบาทและสิทธิ์การใช้งาน (Roles)
|
||||
|
||||
| บทบาท | สิทธิ์การใช้งาน |
|
||||
| --- | --- |
|
||||
| Owner | เจ้าของบริษัท ใช้งานได้ทุกเมนู รวมถึงการตั้งค่าบริษัทและการจัดการผู้ใช้ |
|
||||
| Admin | จัดการข้อมูลหลัก ผู้ใช้งาน สิทธิ์การเข้าถึง และใช้งานทุกโมดูลปฏิบัติการ |
|
||||
| Staff | บันทึกรายการคลังสินค้า ขาย จัดซื้อ และการเงิน ตามสิทธิ์ที่ได้รับ |
|
||||
| Viewer | ดูหน้าจอและรายงานที่ได้รับสิทธิ์ แต่ไม่สามารถสร้างหรือแก้ไขรายการได้ |
|
||||
|
||||
เมนูและปุ่มคำสั่งที่แสดงจะเปลี่ยนตามบทบาทและสิทธิ์การเข้าถึงที่ผู้ดูแลระบบกำหนด
|
||||
|
||||
## 3 หน้าแรกและแดชบอร์ด (Dashboard)
|
||||
|
||||
- แดชบอร์ดคลังสินค้าแสดงยอดสินค้าคงเหลือ สินค้าใกล้หมด และความเคลื่อนไหวล่าสุด
|
||||
- แดชบอร์ดบัญชีแสดงภาพรวมรายรับ รายจ่าย และยอดค้างชำระ
|
||||
- ตัวเลขบนแดชบอร์ดคำนวณจากตารางสรุปยอดที่ปรับปรุงตามกำหนดเวลา รายการที่เพิ่งบันทึกอาจแสดงผลช้ากว่าข้อมูลจริงเล็กน้อย
|
||||
|
||||
## 4 การตั้งค่าข้อมูลหลัก (Master Data)
|
||||
|
||||
ก่อนเริ่มบันทึกรายการ ผู้ใช้ระดับ Owner หรือ Admin ต้องตั้งค่าข้อมูลหลักตามลำดับ
|
||||
|
||||
1. **คลังสินค้า พื้นที่จัดเก็บ และช่องจัดเก็บ** เลือกใช้โครงสร้างแบบคลังเดียวหรือแบบหลายชั้น (คลัง / พื้นที่ / ช่อง) ตามลักษณะการทำงาน
|
||||
2. **หมวดสินค้าและสินค้า** ระบุรหัสสินค้า ชื่อ หน่วยนับ และรูปสินค้า
|
||||
3. **ประเภทผู้ติดต่อและผู้ติดต่อ** บันทึกข้อมูลลูกค้าและผู้ขายที่ใช้ในเอกสารขายและจัดซื้อ
|
||||
4. **ข้อมูลบริษัทและ SMTP** ตั้งค่าข้อมูลบริษัท โลโก้ และบัญชีอีเมลสำหรับส่งการแจ้งเตือน
|
||||
|
||||
## 5 งานคลังสินค้า (Inventory Operations)
|
||||
|
||||
| เมนู | ขั้นตอนการใช้งาน |
|
||||
| --- | --- |
|
||||
| รับสินค้าเข้า | เลือกสินค้า ระบุจำนวน ตำแหน่งจัดเก็บ และเอกสารอ้างอิง หากสินค้ามี Lot, Serial Number หรือวันหมดอายุ ให้ระบุเพิ่มเพื่อการสอบกลับ |
|
||||
| จ่ายสินค้าออก | เลือกสินค้าและจำนวนที่ต้องการจ่าย ระบบจะตรวจสอบยอดคงเหลือก่อนอนุมัติรายการ หากจ่ายเกินยอดระบบจะปฏิเสธ |
|
||||
| โอนย้ายสินค้า | ระบุตำแหน่งต้นทางและปลายทาง ระบบจะบันทึกเป็นรายการโอนเดียวที่สอบกลับได้ |
|
||||
| พิมพ์บาร์โค้ด | เลือกสินค้าหรือตำแหน่งจัดเก็บเพื่อพิมพ์ฉลากบาร์โค้ด และใช้เครื่องสแกนในหน้าจอที่รองรับ |
|
||||
| แนบไฟล์ | แนบเอกสารประกอบรายการได้ตามประเภทไฟล์ที่อนุญาต |
|
||||
|
||||
## 6 งานขาย (Sales)
|
||||
|
||||
1. สร้าง**ใบเสนอราคา**ให้ลูกค้า
|
||||
2. แปลงใบเสนอราคาที่ลูกค้าตอบรับเป็น**ใบสั่งขาย**
|
||||
3. ออก**ใบแจ้งหนี้**จากใบสั่งขาย ระบบจะบันทึกรายการบัญชีที่เกี่ยวข้องให้อัตโนมัติ
|
||||
4. กรณีมีการคืนสินค้า ให้บันทึก**ใบรับคืน**และออก**ใบลดหนี้**
|
||||
|
||||
ทุกขั้นตอนต้องเปลี่ยนสถานะตามลำดับที่ระบบกำหนด หากเปลี่ยนสถานะข้ามขั้นระบบจะปฏิเสธพร้อมแสดงข้อความ
|
||||
|
||||
## 7 งานจัดซื้อ (Purchasing)
|
||||
|
||||
1. บันทึก**ใบขอซื้อ**และส่งให้ผู้มีอำนาจอนุมัติ
|
||||
2. แปลงใบขอซื้อที่อนุมัติแล้วเป็น**ใบสั่งซื้อ**
|
||||
3. เมื่อได้รับสินค้าให้บันทึก**ใบแจ้งหนี้ซื้อ** ระบบจะรับสินค้าเข้าคลังและบันทึกบัญชีที่เกี่ยวข้อง
|
||||
4. กรณีคืนสินค้าให้ผู้ขาย ให้บันทึก**ใบคืนสินค้าผู้ขาย**
|
||||
|
||||
## 8 งานการเงินและบัญชี (Finance & Accounting)
|
||||
|
||||
| งาน | รายละเอียด |
|
||||
| --- | --- |
|
||||
| ใบวางบิลรับและใบเสร็จรับเงิน | บันทึกการวางบิลและการรับชำระจากลูกค้า ผูกกับใบแจ้งหนี้ที่เกี่ยวข้อง |
|
||||
| ใบวางบิลจ่ายและใบสำคัญจ่าย | บันทึกการวางบิลและการจ่ายชำระให้ผู้ขาย ผูกกับใบแจ้งหนี้ซื้อ |
|
||||
| ผังบัญชีและแผนก | ผู้ใช้ระดับ Owner หรือ Admin เป็นผู้ดูแลโครงสร้างบัญชี |
|
||||
| สมุดรายวันและบัญชีแยกประเภท | บันทึกรายการบัญชีจากเอกสารต้นทางหรือบันทึกเองตามสิทธิ์ รายการต้องสมดุลจึงจะบันทึกได้ |
|
||||
|
||||
## 9 รายงาน (Reports)
|
||||
|
||||
- รายงานคลังสินค้า ได้แก่ ภาพรวมสต๊อก ความเคลื่อนไหว ความจุคลัง สินค้าใกล้หมด สินค้าหมดอายุ และรายงาน Lot
|
||||
- รายงานการเงิน ได้แก่ งบทดลอง งบกำไรขาดทุน งบดุล ภาษีมูลค่าเพิ่ม สมุดรายวัน และความเคลื่อนไหวบัญชีแยกประเภท
|
||||
- ทุกรายงานกรอง ดู พิมพ์ และส่งออกได้ ภายใต้ขอบเขตบริษัทและสิทธิ์ของผู้ใช้
|
||||
|
||||
## 10 การแจ้งเตือน (Notification)
|
||||
|
||||
ระบบแจ้งเตือนผู้ใช้ที่เกี่ยวข้องแบบ Real-time เมื่อมีการเปลี่ยนสถานะเอกสารที่ต้องดำเนินการต่อ และแจ้งเตือนตามกำหนดเวลาสำหรับสินค้าใกล้หมดและใบแจ้งหนี้ค้างชำระ โดยแจ้งเฉพาะผู้ใช้ที่มีสิทธิ์ในบริบทของบริษัทนั้น
|
||||
|
||||
## 11 การขอความช่วยเหลือ
|
||||
|
||||
- ปัญหาการใช้งานทั่วไป ติดต่อผู้ดูแลระบบของบริษัท
|
||||
- ปัญหาที่เกี่ยวกับการทำงานของระบบ ให้แจ้งผ่านช่องทางสนับสนุนที่ระบุในเอกสาร Maintenance Document
|
||||
- ขั้นตอนการติดตั้ง ตั้งค่า และกู้คืนระบบ อยู่ในเอกสาร Product Operation Guide
|
||||
|
||||
## ผู้จัดทำเอกสาร (Secretary)
|
||||
|
||||
| ชื่อ | ตำแหน่ง | ลายเซ็น | วันที่ |
|
||||
| --- | --- | --- | --- |
|
||||
| คุณธนกร สถิตวิทยากุล | Developer | | |
|
||||
|
||||
## ผู้ตรวจสอบเอกสาร (Reviewer)
|
||||
|
||||
| ชื่อ | ตำแหน่ง | ลายเซ็น | วันที่ |
|
||||
| --- | --- | --- | --- |
|
||||
| คุณเยาวลักษณ์ บางชมภู | Document Control | | |
|
||||
|
||||
## ผู้อนุมัติ (Approval)
|
||||
|
||||
| ชื่อ | ตำแหน่ง | ลายเซ็น | วันที่ |
|
||||
| --- | --- | --- | --- |
|
||||
| คุณเสรี วิริยะสกุลธรณ์ | Project Sponsor | | |
|
||||
-118
@@ -1,118 +0,0 @@
|
||||
# Software User Documentation
|
||||
|
||||
| Document field | Value |
|
||||
|---|---|
|
||||
| Document | Software User Documentation |
|
||||
| Project | BRN WMS |
|
||||
| Project code | 200-WMS-26-001-00 |
|
||||
| Title | User Guide Document |
|
||||
| Project period | 05/01/26–24/08/26 |
|
||||
| Release | 17/08/26 V1.0 |
|
||||
| Standard | ISO/IEC 29110 Basic Profile |
|
||||
| Organizer | Apirach Supattaratpateep (Project Manager), Noppong Chareunsook (System Analyst), Thanakorn Sathitwitayakul (Developer) |
|
||||
| Status | Final — reflects the implemented application at project baseline |
|
||||
|
||||
## Objective
|
||||
|
||||
Provide operational users a guide to accessing and using BRN WMS: onboarding, warehouse/inventory operations, sales, purchasing, finance/accounting, reporting, and notifications.
|
||||
|
||||
## 1. Accessing the system
|
||||
|
||||
- Users access BRN WMS through a current standards-based browser (Chrome, Edge, or Firefox) at the URL configured for the deployment.
|
||||
- The interface is responsive and usable on desktop and warehouse-floor (tablet/mobile) devices.
|
||||
- New company owners register and complete onboarding; users invited by an Owner/Admin complete invited-user onboarding to join the correct company.
|
||||
- Forgot-password recovery is available from the login screen.
|
||||
|
||||
## 2. Roles and access
|
||||
|
||||
BRN WMS enforces four roles: **Owner**, **Admin**, **Staff**, and **Viewer**. Menu items and actions shown to a user reflect their role and any additional application-access restrictions set by an Admin/Owner. A Viewer can see authorized screens and reports but cannot create or edit transactions.
|
||||
|
||||
## 3. Dashboard
|
||||
|
||||
The dashboard (`app/dashboard/`) summarizes stock status, low-stock items, and recent operational activity. An accounting-focused dashboard (`app/ac_dashboard/`) summarizes financial position. Dashboard figures refresh from scheduled aggregate jobs, so very recent transactions may briefly lag behind live data.
|
||||
|
||||
## 4. Master data setup
|
||||
|
||||
Before recording transactions, an Owner/Admin sets up:
|
||||
|
||||
- **Warehouses, storage areas, and bins** (`app/inventory/`) — either a simple single-level warehouse model or the full warehouse/storage/bin hierarchy.
|
||||
- **Product categories and products** (`app/inventory/`).
|
||||
- **Contacts and contact types** (`app/contact/`) — customers and suppliers.
|
||||
- **Company settings, SMTP, and application access** (`app/setting/`).
|
||||
|
||||
## 5. Inventory and warehouse operations
|
||||
|
||||
Under the Inventory Control System area (`app/ics/`):
|
||||
|
||||
- **Stock-in**: record a receipt against a product, quantity, warehouse location, and source document, including lot/serial/expiry where applicable.
|
||||
- **Stock-out**: issue stock against an authorized document; the system validates available balance before allowing the issue.
|
||||
- **Stock transfer**: move stock between authorized locations as one linked transaction.
|
||||
- **Barcode labels**: generate SKU and location barcode labels and use a barcode scanner (or manual entry) on supported screens.
|
||||
- **Stock reports**: stock overview, movement history, capacity/occupancy, low-stock, expired-stock, and product-lot views are available under Reports (`app/reports/`).
|
||||
|
||||
## 6. Sales workflow
|
||||
|
||||
Under Sales/Revenue (`app/order/`, `app/revenue/`):
|
||||
|
||||
1. Create a **quotation** for a customer.
|
||||
2. Convert an accepted quotation to a **sales order**.
|
||||
3. Issue an **invoice** against the order.
|
||||
4. Process a **return** or **credit note** where applicable.
|
||||
|
||||
Each step follows the document's permitted status transitions; an invalid transition is rejected.
|
||||
|
||||
## 7. Purchasing workflow
|
||||
|
||||
Under Purchasing (`app/po/`):
|
||||
|
||||
1. Raise a **purchase request**.
|
||||
2. Convert an approved request to a **purchase order**.
|
||||
3. Record the **purchase invoice** on receipt of supplier goods/services.
|
||||
4. Process a **supplier return** where applicable.
|
||||
|
||||
## 8. Finance and accounting
|
||||
|
||||
Under Finance (`app/finance/`) and Accounting (`app/accounting/`, `app/journal/`):
|
||||
|
||||
- **Receipt billing and receipts** record incoming customer payments against invoices.
|
||||
- **Payment billing and payments** record outgoing supplier payments against purchase invoices.
|
||||
- **Chart of accounts, departments, and account formulas** are maintained by an Owner/Admin.
|
||||
- **Journals and general-ledger entries** are posted from source documents or manually where permitted; entries must balance.
|
||||
- **Financial reports** — trial balance, profit-and-loss, balance sheet, VAT, journal, and GL-movement — are available under Reports.
|
||||
|
||||
## 9. Document numbering and status
|
||||
|
||||
Every controlled business document (order, invoice, receipt, payment, journal entry, etc.) receives a system-generated document number following the configured sequence, and moves through a defined lifecycle of statuses. Users cannot force an invalid status transition.
|
||||
|
||||
## 10. Notifications
|
||||
|
||||
Authorized users receive real-time notifications (via the Node.js notification service) for relevant status transitions — for example, a new order, an approval request, or a low-stock alert — scoped to their authorized company/role context.
|
||||
|
||||
## 11. Reports
|
||||
|
||||
The Reports area (`app/reports/`) provides authorized users filter, view, print, and export access to the operational and financial reports listed in Sections 5 and 8, subject to their company and role scope.
|
||||
|
||||
## Approval
|
||||
|
||||
### Prepared by
|
||||
|
||||
Name: Thanakorn Sathitwitayakul
|
||||
Role: Developer
|
||||
Signature: ______________________________________________
|
||||
Date: ___________________________________________________
|
||||
|
||||
### Reviewed by
|
||||
|
||||
Name: Apirach Supattaratpateep
|
||||
Role: Project Manager
|
||||
Signature: ______________________________________________
|
||||
Date: ___________________________________________________
|
||||
|
||||
### Reviewed and authorized by
|
||||
|
||||
Name: Seri Viriyasakultorn
|
||||
Project roles: Project Sponsor / Customer Representative / Authorized Approver
|
||||
Position: Managing Director
|
||||
Company: B.R.N. Enterprise Co., Ltd.
|
||||
Signature: ______________________________________________
|
||||
Date: ___________________________________________________
|
||||
Reference in New Issue
Block a user