np-dms/lcbp3
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

251218:1701 On going update to 1.7.0: Documnet Number rebuild
Some checks failed
Spec Validation / validate-markdown (push) Has been cancelled
Details
Spec Validation / validate-diagrams (push) Has been cancelled
Details
Spec Validation / check-todos (push) Has been cancelled
Details

Browse Source
This commit is contained in:
admin
2025-12-18 17:01:42 +07:00
parent aaa5da3ec1
commit 83704377f4
102 changed files with 3385 additions and 1451 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
specs/01-requirements/README.md
View File

@@ -1,8 +1,8 @@
# 📋 Requirements Specification
**Version:** 1.6.0
**Version:** 1.7.0
**Status:** Active
**Last Updated:** 2025-12-13
**Last Updated:** 2025-12-18
---
@@ -16,31 +16,31 @@ This directory contains the functional and non-functional requirements for the L
### Core Requirements
1. [Objectives & Goals](./01-objectives.md) - Project objectives and success criteria
2. [System Architecture & Technology](./02-architecture.md) - High-level architecture requirements
3. [Functional Requirements](./03-functional-requirements.md) - Detailed feature specifications
1. [Objectives & Goals](./01-01-objectives.md) - Project objectives and success criteria
2. [System Architecture & Technology](./01-02-architecture.md) - High-level architecture requirements
3. [Functional Requirements](./01-03-functional-requirements.md) - Detailed feature specifications
### Functional Areas
#### Document Management
- [3.1 Project & Organization Management](./03.1-project-management.md) - Projects, contracts, organizations
- [3.2 Correspondence Management](./03.2-correspondence.md) - Letters and communications
- [3.3 RFA Management](./03.3-rfa.md) - Request for Approval
- [3.4 Contract Drawing Management](./03.4-contract-drawing.md) - Contract drawings (แบบคู่สัญญา)
- [3.5 Shop Drawing Management](./03.5-shop-drawing.md) - Shop drawings (แบบก่อสร้าง)
- [3.1 Project & Organization Management](./01-03.1-project-management.md) - Projects, contracts, organizations
- [3.2 Correspondence Management](./01-03.2-correspondence.md) - Letters and communications
- [3.3 RFA Management](./01-03.3-rfa.md) - Request for Approval
- [3.4 Contract Drawing Management](./01-03.4-contract-drawing.md) - Contract drawings (แบบคู่สัญญา)
- [3.5 Shop Drawing Management](./01-03.5-shop-drawing.md) - Shop drawings (แบบก่อสร้าง)
#### Supporting Features
- [3.6 Unified Workflow](./03.6-unified-workflow.md) - Workflow engine and routing
- [3.7 Transmittals Management](./03.7-transmittals.md) - Document transmittals
- [3.8 Circulation Sheet Management](./03.8-circulation-sheet.md) - Document circulation
- [3.9 Revisions Management](./03.9-revisions.md) - Version control
- [3.10 File Handling](./03.10-file-handling.md) - File storage and processing
- [3.6 Unified Workflow](./01-03.6-unified-workflow.md) - Workflow engine and routing
- [3.7 Transmittals Management](./01-03.7-transmittals.md) - Document transmittals
- [3.8 Circulation Sheet Management](./01-03.8-circulation-sheet.md) - Document circulation
- [3.9 Revisions Management](./01-03.9-logs.md) - Version control
- [3.10 File Handling](./01-03.10-file-handling.md) - File storage and processing
#### **⭐ Document Numbering System**
- [3.11 Document Numbering](./03.11-document-numbering.md) - **Requirements**
- [3.11 Document Numbering](./01-03.11-document-numbering.md) - **Requirements**
- Automatic number generation
- Template-based formatting
- Concurrent request handling
@@ -48,19 +48,19 @@ This directory contains the functional and non-functional requirements for the L
**Implementation & Operations:**
- 📘 [Implementation Guide](../03-implementation/document-numbering.md) - NestJS, TypeORM, Redis code examples
- 📗 [Operations Guide](../04-operations/document-numbering-operations.md) - Monitoring, troubleshooting, runbooks
- 📘 [Implementation Guide](../03-implementation/03-04-document-numbering.md) - NestJS, TypeORM, Redis code examples
- 📗 [Operations Guide](../04-operations/04-08-document-numbering-operations.md) - Monitoring, troubleshooting, runbooks
#### Technical Details
- [3.12 JSON Details](./03.12-json-details.md) - JSON field specifications
- [3.12 JSON Details](./01-03.12-json-details.md) - JSON field specifications
### Cross-Cutting Concerns
4. [Access Control & RBAC](./04-access-control.md) - 4-level hierarchical RBAC
5. [UI/UX Requirements](./05-ui-ux.md) - User interface specifications
6. [Non-Functional Requirements](./06-non-functional.md) - Performance, security, scalability
7. [Testing Requirements](./07-testing.md) - Test strategy and coverage
4. [Access Control & RBAC](./01-04-access-control.md) - 4-level hierarchical RBAC
5. [UI/UX Requirements](./01-05-ui-ux.md) - User interface specifications
6. [Non-Functional Requirements](./01-06-non-functional.md) - Performance, security, scalability
7. [Testing Requirements](./01-07-testing.md) - Test strategy and coverage
---
@@ -76,8 +76,8 @@ This directory contains the functional and non-functional requirements for the L
- ✅ **Reorganized Document Numbering documentation**
- Split into: Requirements → Implementation → Operations
- Created [document-numbering.md](../03-implementation/document-numbering.md) implementation guide
- Created [document-numbering-operations.md](../04-operations/document-numbering-operations.md) ops guide
- Created [document-numbering.md](../03-implementation/03-04-document-numbering.md) implementation guide
- Created [document-numbering-operations.md](../04-operations/04-08-document-numbering-operations.md) ops guide
- ✅ Updated schema to match v1.6.0 requirements
- ✅ Enhanced cross-references between documents
@@ -101,19 +101,19 @@ See [CHANGELOG.md](../../CHANGELOG.md) for detailed version history.
### By Feature Status
| Feature Area | Requirements Doc | Status | Implementation | Operations |
| ------------------------- | -------------------------------------- | ---------- | ----------------------------------------------------- | ------------------------------------------------------------ |
| Correspondence Management | [03.2](./03.2-correspondence.md) | ✅ Complete | ✅ Complete | Available |
| RFA Management | [03.3](./03.3-rfa.md) | ✅ Complete | ✅ Complete | Available |
| Contract Drawing | [03.4](./03.4-contract-drawing.md) | ✅ Complete | ✅ Complete | Available |
| Shop Drawing | [03.5](./03.5-shop-drawing.md) | ✅ Complete | ✅ Complete | Available |
| Workflow Engine | [03.6](./03.6-unified-workflow.md) | ✅ Complete | ✅ Complete | Available |
| Transmittals | [03.7](./03.7-transmittals.md) | ✅ Complete | ✅ Complete | Available |
| Circulation Sheets | [03.8](./03.8-circulation-sheet.md) | ✅ Complete | ✅ Complete | Available |
| **Document Numbering** | [03.11](./03.11-document-numbering.md) | ✅ Complete | ✅ [Guide](../03-implementation/document-numbering.md) | ✅ [Guide](../04-operations/document-numbering-operations.md) |
| Access Control (RBAC) | [04](./04-access-control.md) | ✅ Complete | ✅ Complete | Available |
| Search (Elasticsearch) | N/A | ✅ Complete | 🔄 95% | Available |
| Dashboard & Analytics | N/A | ✅ Complete | ✅ Complete | Available |
| Feature Area | Requirements Doc | Status | Implementation | Operations |
| ------------------------- | ----------------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------ |
| Correspondence Management | [03.2](./01-03.2-correspondence.md) | ✅ Complete | ✅ Complete | Available |
| RFA Management | [03.3](./01-03.3-rfa.md) | ✅ Complete | ✅ Complete | Available |
| Contract Drawing | [03.4](./01-03.4-contract-drawing.md) | ✅ Complete | ✅ Complete | Available |
| Shop Drawing | [03.5](./01-03.5-shop-drawing.md) | ✅ Complete | ✅ Complete | Available |
| Workflow Engine | [03.6](./01-03.6-unified-workflow.md) | ✅ Complete | ✅ Complete | Available |
| Transmittals | [03.7](./01-03.7-transmittals.md) | ✅ Complete | ✅ Complete | Available |
| Circulation Sheets | [03.8](./01-03.8-circulation-sheet.md) | ✅ Complete | ✅ Complete | Available |
| **Document Numbering** | [03.11](./01-03.11-document-numbering.md) | ✅ Complete | ✅ [Guide](../03-implementation/03-04-document-numbering.md) | ✅ [Guide](../04-operations/04-08-document-numbering-operations.md) |
| Access Control (RBAC) | [04](./01-04-access-control.md) | ✅ Complete | ✅ Complete | Available |
| Search (Elasticsearch) | N/A | ✅ Complete | 🔄 95% | Available |
| Dashboard & Analytics | N/A | ✅ Complete | ✅ Complete | Available |
### By Priority
@@ -141,8 +141,8 @@ All requirements documents must meet these criteria:
### For Product Owners / Business Analysts
1. Start with [Objectives & Goals](./01-objectives.md)
2. Review [Functional Requirements](./03-functional-requirements.md)
1. Start with [Objectives & Goals](./01-01-objectives.md)
2. Review [Functional Requirements](./01-03-functional-requirements.md)
3. Check specific feature requirements (3.1-3.12)
### For Developers
@@ -154,13 +154,13 @@ All requirements documents must meet these criteria:
### For QA / Testers
1. Review [Testing Requirements](./07-testing.md)
1. Review [Testing Requirements](./01-07-testing.md)
2. Use requirements as test case source
3. Verify [Non-Functional Requirements](./06-non-functional.md)
3. Verify [Non-Functional Requirements](./01-06-non-functional.md)
### For Operations Team
1. Read [Non-Functional Requirements](./06-non-functional.md) for SLAs
1. Read [Non-Functional Requirements](01-06-non-functional.md) for SLAs
2. Check [Operations Guides](../04-operations/) for specific features
3. Review monitoring and alerting requirements
@@ -178,8 +178,8 @@ All requirements documents must meet these criteria:
## 📝 Document Control
- **Version:** 1.6.0
- **Version:** 1.7.0
- **Owner:** System Architect (Nattanin Peancharoen)
- **Last Review:** 2025-12-13
- **Last Review:** 2025-12-18
- **Next Review:** 2026-01-01
- **Classification:** Internal Use Only