186 lines
8.3 KiB
Markdown
186 lines
8.3 KiB
Markdown
# 📋 Requirements Specification
|
|
|
|
**Version:** 1.6.0
|
|
**Status:** Active
|
|
**Last Updated:** 2025-12-13
|
|
|
|
---
|
|
|
|
## 📖 Overview
|
|
|
|
This directory contains the functional and non-functional requirements for the LCBP3-DMS (Laem Chabang Port Phase 3 - Document Management System). The requirements are organized by functional area and feature.
|
|
|
|
---
|
|
|
|
## 📑 Table of Contents
|
|
|
|
### 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
|
|
|
|
### 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 (แบบก่อสร้าง)
|
|
|
|
#### 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
|
|
|
|
#### **⭐ Document Numbering System**
|
|
|
|
- [3.11 Document Numbering](./03.11-document-numbering.md) - **Requirements**
|
|
- Automatic number generation
|
|
- Template-based formatting
|
|
- Concurrent request handling
|
|
- Counter management
|
|
|
|
**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
|
|
|
|
#### Technical Details
|
|
|
|
- [3.12 JSON Details](./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
|
|
|
|
---
|
|
|
|
## 🔄 Recent Changes
|
|
|
|
### v1.6.0 (2025-12-13)
|
|
|
|
- ✅ **Schema Refactoring** - Major restructuring of correspondence and RFA tables
|
|
- ✅ Updated data dictionary for schema v1.6.0
|
|
- ✅ Breaking changes documented in CHANGELOG.md
|
|
|
|
### v1.5.1 (2025-12-02)
|
|
|
|
- ✅ **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
|
|
- ✅ Updated schema to match v1.6.0 requirements
|
|
- ✅ Enhanced cross-references between documents
|
|
|
|
### v1.5.0 (2025-12-01)
|
|
|
|
- ✅ Added comprehensive security requirements
|
|
- ✅ Enhanced resilience patterns
|
|
- ✅ Added performance targets
|
|
- ⚠️ **Breaking:** Changed document numbering from stored procedure to app-level locking
|
|
|
|
### v1.4.5 (2025-11-30)
|
|
|
|
- ✅ Initial requirements documentation
|
|
- ✅ Functional requirements specified
|
|
|
|
See [CHANGELOG.md](../../CHANGELOG.md) for detailed version history.
|
|
|
|
---
|
|
|
|
## 📊 Requirements Traceability
|
|
|
|
### 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 |
|
|
|
|
### By Priority
|
|
|
|
- **P0 (Critical):** Access Control, Document Numbering
|
|
- **P1 (High):** Correspondence, RFA, Workflow Engine
|
|
- **P2 (Medium):** Transmittals, Circulation, Search
|
|
- **P3 (Low):** Reporting, Analytics
|
|
|
|
---
|
|
|
|
## 🎯 Requirements Quality Checklist
|
|
|
|
All requirements documents must meet these criteria:
|
|
|
|
- [ ] **Clear:** Written in simple, unambiguous language
|
|
- [ ] **Testable:** Can be verified through testing
|
|
- [ ] **Traceable:** Linked to business objectives
|
|
- [ ] **Feasible:** Technically achievable within constraints
|
|
- [ ] **Complete:** All edge cases and scenarios covered
|
|
- [ ] **Consistent:** No contradictions with other requirements
|
|
|
|
---
|
|
|
|
## 📖 Reading Guide
|
|
|
|
### For Product Owners / Business Analysts
|
|
|
|
1. Start with [Objectives & Goals](./01-objectives.md)
|
|
2. Review [Functional Requirements](./03-functional-requirements.md)
|
|
3. Check specific feature requirements (3.1-3.12)
|
|
|
|
### For Developers
|
|
|
|
1. Read requirements document for your feature
|
|
2. Check [Implementation Guides](../03-implementation/) for technical details
|
|
3. Review [ADRs](../05-decisions/) for architectural decisions
|
|
4. Check [Tasks](../06-tasks/) for development breakdown
|
|
|
|
### For QA / Testers
|
|
|
|
1. Review [Testing Requirements](./07-testing.md)
|
|
2. Use requirements as test case source
|
|
3. Verify [Non-Functional Requirements](./06-non-functional.md)
|
|
|
|
### For Operations Team
|
|
|
|
1. Read [Non-Functional Requirements](./06-non-functional.md) for SLAs
|
|
2. Check [Operations Guides](../04-operations/) for specific features
|
|
3. Review monitoring and alerting requirements
|
|
|
|
---
|
|
|
|
## 📬 Feedback & Issues
|
|
|
|
**Found issues or have suggestions?**
|
|
|
|
- Requirements clarity issues → [Open Issue](https://github.com/your-org/lcbp3-dms/issues/new?template=spec-issue.md)
|
|
- Feature requests → Contact Product Owner
|
|
- Technical questions → Contact System Architect
|
|
|
|
---
|
|
|
|
## 📝 Document Control
|
|
|
|
- **Version:** 1.6.0
|
|
- **Owner:** System Architect (Nattanin Peancharoen)
|
|
- **Last Review:** 2025-12-13
|
|
- **Next Review:** 2026-01-01
|
|
- **Classification:** Internal Use Only
|