690602:0957 ADR-033-233 #01
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
# Architecture Decision Records (ADRs)
|
||||
|
||||
**Version:** 1.9.5
|
||||
**Last Updated:** 2026-05-18
|
||||
**Version:** 1.9.8
|
||||
**Last Updated:** 2026-06-02
|
||||
**Project:** LCBP3-DMS (Laem Chabang Port Phase 3 - Document Management System)
|
||||
|
||||
---
|
||||
@@ -25,9 +25,9 @@ Architecture Decision Records (ADRs) เป็นเอกสารที่บ
|
||||
2. ป้องกันการสงสัยว่า "ทำไมถึงออกแบบแบบนี้" ในอนาคต
|
||||
3. ช่วยในการ Onboard สมาชิกใหม่
|
||||
4. บันทึกประวัติศาสตร์การพัฒนาโปรเจกต์
|
||||
5. **ใหม่!** เชื่อมโยงการตัดสินใจกับ Requirements และ Acceptance Criteria
|
||||
6. **ใหม่!** วิเคราะห์ผลกระทบอย่างเป็นระบบ
|
||||
7. **ใหม่!** จัดการ Version Dependencies ระหว่าง ADRs
|
||||
5. เชื่อมโยงการตัดสินใจกับ Requirements และ Acceptance Criteria
|
||||
6. วิเคราะห์ผลกระทบอย่างเป็นระบบ
|
||||
7. จัดการ Version Dependencies ระหว่าง ADRs
|
||||
|
||||
---
|
||||
|
||||
@@ -35,69 +35,77 @@ Architecture Decision Records (ADRs) เป็นเอกสารที่บ
|
||||
|
||||
### Core Architecture Decisions
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| --------------------------------------------------- | --------------------------- | ----------- | ---------- | ---------------------------------------------------------------------------- |
|
||||
| [ADR-001](./ADR-001-unified-workflow-engine.md) | Unified Workflow Engine | ✅ Accepted | 2026-02-24 | ใช้ DSL-based Workflow Engine สำหรับ Correspondences, RFAs, และ Circulations |
|
||||
| [ADR-002](./ADR-002-document-numbering-strategy.md) | Document Numbering Strategy | ✅ Accepted | 2026-02-24 | Double-lock mechanism (Redis + DB Optimistic Lock) สำหรับเลขที่เอกสาร |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-001](./ADR-001-unified-workflow-engine.md) | Unified Workflow Engine | ✅ Accepted | 2026-02-24 | ใช้ DSL-based Workflow Engine สำหรับ Correspondences, RFAs, และ Circulations |
|
||||
| [ADR-002](./ADR-002-document-numbering-strategy.md) | Document Numbering Strategy | ✅ Accepted | 2026-02-24 | Double-lock mechanism (Redis + DB Optimistic Lock) สำหรับเลขที่เอกสาร |
|
||||
|
||||
### Security & Access Control
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| ----------------------------------------------- | ---------------------------------- | ----------- | ---------- | -------------------------------------------- |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-016](./ADR-016-security-authentication.md) | Security & Authentication Strategy | ✅ Accepted | 2026-02-24 | JWT + bcrypt + OWASP Security Best Practices |
|
||||
|
||||
### Technology & Infrastructure
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| --------------------------------------------------- | ------------------------------------ | --------------------- | ---------- | --------------------------------------------------------------- |
|
||||
| [ADR-004](./ADR-004-database-schema-design-strategy.md) | Database Schema Design Strategy | ✅ Accepted | 2026-04-04 | Selective Normalization + Standard Patterns (UUID, Soft Delete, Audit) |
|
||||
| [ADR-005](./ADR-005-technology-stack.md) | Technology Stack Selection | ✅ Accepted | 2026-02-24 | Full Stack TypeScript: NestJS 11 + Next.js 16 + MariaDB + Redis |
|
||||
| [ADR-006](./ADR-006-redis-caching-strategy.md) | Redis Usage & Caching Strategy | ✅ Accepted | 2026-02-24 | Redis สำหรับ Distributed Lock, Cache, Queue, และ Rate Limiting |
|
||||
| [ADR-009](./ADR-009-database-migration-strategy.md) | Database Migration & Deployment | ✅ Accepted (Pending) | 2026-02-24 | TypeORM Migrations พร้อม Blue-Green Deployment |
|
||||
| [ADR-015](./ADR-015-deployment-infrastructure.md) | Deployment & Infrastructure Strategy | ✅ Accepted | 2026-02-24 | Docker Compose with Blue-Green Deployment on QNAP |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-004](./ADR-004-database-schema-design-strategy.md) | Database Schema Design Strategy | ✅ Accepted | 2026-04-04 | Selective Normalization + Standard Patterns (UUID, Soft Delete, Audit) |
|
||||
| [ADR-005](./ADR-005-technology-stack.md) | Technology Stack Selection | ✅ Accepted | 2026-02-24 | Full Stack TypeScript: NestJS 11 + Next.js 16 + MariaDB + Redis |
|
||||
| [ADR-006](./ADR-006-redis-caching-strategy.md) | Redis Usage & Caching Strategy | ✅ Accepted | 2026-02-24 | Redis สำหรับ Distributed Lock, Cache, Queue, และ Rate Limiting |
|
||||
| [ADR-009](./ADR-009-database-migration-strategy.md) | Database Migration & Deployment | ✅ Accepted | 2026-02-24 | TypeORM Migrations พร้อม Blue-Green Deployment |
|
||||
| [ADR-015](./ADR-015-deployment-infrastructure.md) | Deployment & Infrastructure Strategy | ✅ Accepted | 2026-02-24 | Docker Compose with Blue-Green Deployment on QNAP |
|
||||
|
||||
### API & Integration
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| --------------------------------------------------- | ----------------------------- | ---------------------------- | ---------- | ----------------------------------------------------------------------------- |
|
||||
| [ADR-003](./ADR-003-api-design-strategy.md) | API Design Strategy | ✅ Accepted | 2026-04-04 | Hybrid REST + Action Strategy สำหรับ Resource และ Workflow Operations |
|
||||
| [ADR-007](./ADR-007-error-handling-strategy.md) | Error Handling & Recovery | ✅ Accepted | 2026-04-04 | Layered Error Classification พร้อม User-friendly Messages และ Recovery Actions |
|
||||
| [ADR-008](./ADR-008-email-notification-strategy.md) | Email & Notification Strategy | ✅ Accepted (Pending Review) | 2026-02-24 | BullMQ + Redis Queue สำหรับ Multi-channel Notifications (Email, LINE, In-app) |
|
||||
| [ADR-031](./ADR-031-hermes-agent-telegram-devops-bridge.md) | Hermes Agent & Telegram DevOps Bridge | 📝 Draft | 2026-05-28 | Hermes เป็น optional Developer Operations Agent พร้อม Telegram DevOps commands, read-only diagnostics, และ staged rollout |
|
||||
| [ADR-032](./ADR-032-typhoon-ocr-integration.md) | Typhoon OCR Integration | 📝 Draft | 2026-05-30 | Typhoon OCR-3B และ typhoon2.1-gemma3-4b เป็นทางเลือก OCR/LLM บน Admin Desktop พร้อม VRAM monitoring และ Redis caching |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-003](./ADR-003-api-design-strategy.md) | API Design Strategy | ✅ Accepted | 2026-04-04 | Hybrid REST + Action Strategy สำหรับ Resource และ Workflow Operations |
|
||||
| [ADR-007](./ADR-007-error-handling-strategy.md) | Error Handling & Recovery | ✅ Accepted | 2026-04-04 | Layered Error Classification พร้อม User-friendly Messages และ Recovery Actions |
|
||||
| [ADR-008](./ADR-008-email-notification-strategy.md) | Email & Notification Strategy | ✅ Accepted | 2026-02-24 | BullMQ + Redis Queue สำหรับ Multi-channel Notifications (Email, LINE, In-app) |
|
||||
| [ADR-031](./ADR-031-hermes-agent-telegram-devops-bridge.md) | Hermes Agent & Telegram DevOps Bridge | ✅ Accepted | 2026-05-28 | Hermes DevOps Telegram Bridge สำหรับอ่าน diagnostics และ staged rollout |
|
||||
|
||||
### Observability
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| --------------------------------------------------- | ----------------------------- | --------------------- | ---------- | ------------------------------------------------------------- |
|
||||
| [ADR-010](./ADR-010-logging-monitoring-strategy.md) | Logging & Monitoring Strategy | ✅ Accepted (Pending) | 2026-02-24 | Winston Structured Logging พร้อม Future ELK Stack Integration |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-010](./ADR-010-logging-monitoring-strategy.md) | Logging & Monitoring Strategy | ✅ Accepted | 2026-02-24 | Winston Structured Logging พร้อม Future ELK Stack Integration |
|
||||
|
||||
### Frontend Architecture
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| ------------------------------------------------ | -------------------------------- | ----------- | ---------- | ----------------------------------------------------- |
|
||||
| [ADR-011](./ADR-011-nextjs-app-router.md) | Next.js App Router & Routing | ✅ Accepted | 2025-12-01 | App Router with Server Components and Nested Layouts |
|
||||
| [ADR-012](./ADR-012-ui-component-library.md) | UI Component Library (Shadcn/UI) | ✅ Accepted | 2026-02-24 | Shadcn/UI + Tailwind CSS for Full Component Ownership |
|
||||
| [ADR-013](./ADR-013-form-handling-validation.md) | Form Handling & Validation | ✅ Accepted | 2026-02-24 | React Hook Form + Zod for Type-Safe Forms |
|
||||
| [ADR-014](./ADR-014-state-management.md) | State Management Strategy | ✅ Accepted | 2026-02-24 | Zustand for Client State + Server Components |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-011](./ADR-011-nextjs-app-router.md) | Next.js App Router & Routing | ✅ Accepted | 2025-12-01 | App Router with Server Components and Nested Layouts |
|
||||
| [ADR-012](./ADR-012-ui-component-library.md) | UI Component Library (Shadcn/UI) | ✅ Accepted | 2026-02-24 | Shadcn/UI + Tailwind CSS for Full Component Ownership |
|
||||
| [ADR-013](./ADR-013-form-handling-validation.md) | Form Handling & Validation | ✅ Accepted | 2026-02-24 | React Hook Form + Zod for Type-Safe Forms |
|
||||
| [ADR-014](./ADR-014-state-management.md) | State Management Strategy | ✅ Accepted | 2026-02-24 | Zustand for Client State + Server Components |
|
||||
|
||||
### Data & Identity
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| -------------------------------------------------- | -------------------------- | ----------- | ---------- | ---------------------------------------------------- |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-019](./ADR-019-hybrid-identifier-strategy.md) | Hybrid Identifier Strategy | ✅ Accepted | 2026-03-11 | INT PK (internal) + UUIDv7 (public API) on 14 tables |
|
||||
|
||||
### AI & Data Integration
|
||||
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| ----------------------------------------------- | ---------------------------------- | ------------- | ---------- | ---------------------------------------------------------------------------- |
|
||||
| [ADR-017](./ADR-017-ollama-data-migration.md) | Ollama Data Migration Architecture | ❌ Superseded | 2026-02-26 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-017B](./ADR-017B-ai-document-classification.md) | AI Document Classification | ❌ Superseded | 2026-03-27 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-018](./ADR-018-ai-boundary.md) | AI Boundary Policy | ❌ Superseded | 2026-03-27 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-020](./ADR-020-ai-intelligence-integration.md) | AI Intelligence Integration Architecture | ❌ Superseded | 2026-04-03 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-022](./ADR-022-retrieval-augmented-generation.md) | Retrieval-Augmented Generation (RAG) | ❌ Superseded | 2026-04-20 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-023](./ADR-023-unified-ai-architecture.md) | Unified AI Architecture | ✅ Accepted | 2026-05-14 | สถาปัตยกรรม AI หลักแบบรวมศูนย์ (Boundary, RAG, Workflows และ Isolation) |
|
||||
| [ADR-023A](./ADR-023A-unified-ai-architecture.md) | AI Model Revision | ✅ Accepted | 2026-05-15 | 2-Model Stack (gemma4:e4b Q8_0 + nomic-embed-text), BullMQ 2-Queue, RAG embed scope, OCR auto-detect |
|
||||
| ADR | Title | Status | Date | Summary |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [ADR-017](./ADR-017-ollama-data-migration.md) | Ollama Data Migration Architecture | ❌ Superseded | 2026-02-26 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-017B](./ADR-017B-ai-document-classification.md) | AI Document Classification | ❌ Superseded | 2026-03-27 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-018](./ADR-018-ai-boundary.md) | AI Boundary Policy | ❌ Superseded | 2026-03-27 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-020](./ADR-020-ai-intelligence-integration.md) | AI Intelligence Integration Architecture | ❌ Superseded | 2026-04-03 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-022](./ADR-022-retrieval-augmented-generation.md) | Retrieval-Augmented Generation (RAG) | ❌ Superseded | 2026-04-20 | ถูกแทนที่โดย ADR-023: Unified AI Architecture |
|
||||
| [ADR-023](./ADR-023-unified-ai-architecture.md) | Unified AI Architecture | ✅ Accepted | 2026-05-14 | สถาปัตยกรรม AI หลักแบบรวมศูนย์ (Boundary, RAG, Workflows และ Isolation) |
|
||||
| [ADR-023A](./ADR-023A-unified-ai-architecture.md) | AI Model Revision | ✅ Accepted | 2026-05-15 | 2-Model Stack (gemma4:e4b Q8_0 + nomic-embed-text), BullMQ 2-Queue, RAG embed scope, OCR auto-detect |
|
||||
| [ADR-024](./ADR-024-intent-classification-strategy.md) | Intent Classification Strategy | ✅ Accepted | 2026-05-20 | Hybrid Pattern→LLM Fallback กับ ai_intent_patterns ใน DB และ caching 5 นาที |
|
||||
| [ADR-025](./ADR-025-ai-tool-layer-architecture.md) | AI Tool Layer Architecture | ✅ Accepted | 2026-05-21 | Server-side tool dispatch พร้อม CASL permission validation สำหรับ AI assistant |
|
||||
| [ADR-026](./ADR-026-document-chat-ui-pattern.md) | Document Chat UI Pattern | ✅ Accepted | 2026-05-22 | แผง Side-panel Chat UI และ useAiChat() custom hook พร้อม streaming output |
|
||||
| [ADR-027](./ADR-027-ai-admin-console-and-dynamic-control.md) | AI Admin Console & Dynamic Control | ✅ Accepted | 2026-05-22 | ระบบควบคุม prompts, models และ intents ใน UI แบบ dynamic โดยไม่ต้อง redeploy |
|
||||
| [ADR-028](./ADR-028-migration-architecture-refactor.md) | Migration Architecture Refactor | ✅ Accepted | 2026-05-23 | Staging Queue, go/no-go gates และ post-migration cleanup pipeline |
|
||||
| [ADR-029](./ADR-029-dynamic-prompt-management.md) | Dynamic Prompt Management | ✅ Accepted | 2026-05-25 | การเก็บ prompt templates ใน DB (`ai_prompts`) และ Redis cache TTL 60s |
|
||||
| [ADR-030](./ADR-030-context-aware-prompt-templates.md) | Context-Aware Prompt Templates | ✅ Accepted | 2026-05-26 | Dynamic prompts ที่ทำงานสัมพันธ์ตามประเภทเอกสาร สิทธิ์ และ workflow step |
|
||||
| [ADR-032](./ADR-032-typhoon-ocr-integration.md) | Typhoon OCR Integration | ✅ Accepted | 2026-05-30 | Typhoon OCR-3B และ typhoon2.1-gemma3-4b บน Admin Desktop |
|
||||
| [ADR-033](./ADR-033-active-model-and-ocr-management.md) | Active Model & OCR Runner Management | ✅ Accepted | 2026-06-02 | Synchronous Model Loading, GPU VRAM Auto-release และ API Key sidecar protection |
|
||||
|
||||
---
|
||||
|
||||
@@ -117,7 +125,7 @@ Architecture Decision Records (ADRs) เป็นเอกสารที่บ
|
||||
|
||||
### 3. Security & Access Control
|
||||
|
||||
- **ADR-016:** Security - JWT Authentication + OWASP Best Practices
|
||||
- **ADR-016:** Security - JWT Authentication + OWASP Best Practices และ API Key header Protection สำหรับ sidecars
|
||||
|
||||
### 4. Infrastructure & Performance
|
||||
|
||||
@@ -131,6 +139,7 @@ Architecture Decision Records (ADRs) เป็นเอกสารที่บ
|
||||
- **ADR-003:** API Design - Hybrid REST + Action Strategy สำหรับ Resource และ Workflow Operations
|
||||
- **ADR-007:** Error Handling - Layered Classification (Validation / Business / System) พร้อม Recovery Actions
|
||||
- **ADR-008:** Notification - BullMQ Queue สำหรับ Multi-channel notifications
|
||||
- **ADR-031:** Hermes Agent - Telegram DevOps Bridge สำหรับอ่าน diagnostics และ devops commands
|
||||
|
||||
### 6. Observability & Monitoring
|
||||
|
||||
@@ -151,6 +160,8 @@ Architecture Decision Records (ADRs) เป็นเอกสารที่บ
|
||||
|
||||
- **ADR-023:** Unified AI Architecture - สถาปัตยกรรม AI หลักของระบบ ครอบคลุม Boundary, Workflows, RAG และ Hardware Isolation
|
||||
- **ADR-023A:** AI Model Revision - 2-Model Stack (gemma4:e4b Q8_0 + nomic-embed-text), BullMQ 2-Queue, OCR auto-detect
|
||||
- **ADR-024 ถึง ADR-030:** Runtime dynamic system (Intent Classifier, Tool Layer, Chat UI, Dynamic prompts & contexts)
|
||||
- **ADR-032 & ADR-033:** OCR integration, Synchronous Loading, GPU VRAM Auto-release และ FastAPI API Key Protection
|
||||
|
||||
---
|
||||
|
||||
@@ -168,224 +179,12 @@ Architecture Decision Records (ADRs) เป็นเอกสารที่บ
|
||||
6. **🔍 Impact Analysis**: ผลกระทบต่อ Components และ Required Changes
|
||||
7. **📋 Version Dependency Matrix**: ความสัมพันธ์ระหว่าง ADRs และ Version Compatibility
|
||||
8. **Consequences**: ผลที่ตามมา (Positive/Negative/Mitigation)
|
||||
9. **🔄 Review Cycle & Maintenance**: กำหนดการทบทวนและ Version History
|
||||
9. **🔄 Review Cycle & Maintenance**: 定期的なレビュー
|
||||
10. **Implementation Details**: รายละเอียดการ Implement (Code examples)
|
||||
11. **Related ADRs**: ADR อื่นที่เกี่ยวข้อง
|
||||
|
||||
### Reading Tips
|
||||
|
||||
- เริ่มจาก **Context** เพื่อเข้าใจปัญหา
|
||||
- ดู **Considered Options** เพื่อเข้าใจ Trade-offs
|
||||
- อ่าน **Consequences** เพื่อรู้ว่าต้อง Maintain อย่างไร
|
||||
- ดู **Related ADRs** เพื่อเข้าใจภาพรวม
|
||||
|
||||
---
|
||||
|
||||
## 🆕 Enhanced Template & Review Process (v1.8.2)
|
||||
|
||||
### New Features
|
||||
|
||||
#### 🎯 Gap Analysis & Purpose
|
||||
- **ปิด Gap จากเอกสาร**: ระบุว่า ADR นี้แก้ไข Requirement ใด
|
||||
- **แก้ไขความขัดแย้ง**: ระบุว่า ADR นี้แก้ไขความขัดแย้งระหว่าง Requirements ใด
|
||||
|
||||
#### 🔍 Impact Analysis
|
||||
- **Affected Components**: ระดับผลกระทบ (🔴 High, 🟡 Medium, 🟢 Low)
|
||||
- **Required Changes**: แบ่งเป็น Critical/Important/Nice-to-Have
|
||||
- **Cross-Module Dependencies**: Mermaid diagram แสดงความสัมพันธ์
|
||||
|
||||
#### 📋 Version Dependency Matrix
|
||||
- **Dependency Types**: Core, Required, Used By, Conflicts, Supersedes
|
||||
- **Version Compatibility**: ระบุ version ที่ ADR มีผลบังคับใช้
|
||||
- **Implementation Status**: ✅ Implemented, 🔄 In Progress, ⚠️ Must Resolve
|
||||
|
||||
#### 🔄 Review Cycle & Maintenance
|
||||
- **Review Schedule**: ทบทวนทุก 6 เดือนสำหรับ Core ADRs
|
||||
- **Review Checklist**: ตรวจสอบความเป็นปัจจุบัน
|
||||
- **Version History**: Tracking การเปลี่ยนแปลงของ ADR
|
||||
|
||||
### Review Process
|
||||
|
||||
- **Initial Review**: 7 วันทำการสำหรับ ADR ใหม่
|
||||
- **Scheduled Review**: ทุก 6 เดือนสำหรับ Core ADRs
|
||||
- **Triggered Review**: เมื่อมี Major version upgrade หรือ Critical issue
|
||||
|
||||
📖 **ดูรายละเอียด**: [ADR Review Process](./ADR-REVIEW-PROCESS.md)
|
||||
|
||||
---
|
||||
|
||||
## 🆕 Creating New ADRs
|
||||
|
||||
### When to Create an ADR?
|
||||
|
||||
สร้าง ADR เมื่อ:
|
||||
|
||||
- ✅ เลือก Technology/Framework หลัก
|
||||
- ✅ ออกแบบ Architecture Pattern สำคัญ
|
||||
- ✅ แก้ปัญหาซับซ้อนที่มีหลาย Alternatives
|
||||
- ✅ Trade-offs ที่มีผลกระทบระยะยาว
|
||||
- ✅ ตัดสินใจที่ยากจะ Revert (Irreversible decisions)
|
||||
|
||||
**ไม่ต้องสร้าง ADR สำหรับ:**
|
||||
|
||||
- ❌ การเลือก Library เล็กๆ ที่เปลี่ยนได้ง่าย
|
||||
- ❌ Implementation details ที่ไม่กระทบ Architecture
|
||||
- ❌ Coding style หรือ Naming conventions
|
||||
|
||||
### ADR Template
|
||||
|
||||
ใช้ **Enhanced ADR Template v1.2** สำหรับ ADR ใหม่ทั้งหมด:
|
||||
|
||||
📋 **Template**: [ADR-TEMPLATE-enhanced.md](./ADR-TEMPLATE-enhanced.md)
|
||||
|
||||
**Key Sections (ต้องรวมทุกอย่าง):**
|
||||
- ✅ Gap Analysis & Purpose
|
||||
- ✅ Impact Analysis (Components + Required Changes + Dependencies)
|
||||
- ✅ Version Dependency Matrix
|
||||
- ✅ Review Cycle & Maintenance
|
||||
- ✅ Cross-Module Dependencies (Mermaid diagram)
|
||||
|
||||
**Quick Start:**
|
||||
```bash
|
||||
# Copy template
|
||||
cp ADR-TEMPLATE-enhanced.md ADR-XXX-title.md
|
||||
# Edit with your specific content
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 ADR Lifecycle
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> Proposed: Create new ADR
|
||||
Proposed --> Accepted: Team agrees
|
||||
Proposed --> Rejected: Team disagrees
|
||||
Accepted --> Deprecated: No longer relevant
|
||||
Accepted --> Superseded: Replaced by new ADR
|
||||
Deprecated --> [*]
|
||||
Superseded --> [*]
|
||||
Rejected --> [*]
|
||||
```
|
||||
|
||||
### Status Definitions
|
||||
|
||||
- **Proposed**: รอการ Review และ Approve
|
||||
- **Accepted**: ผ่านการ Review แล้ว กำลังใช้งาน
|
||||
- **Deprecated**: เลิกใช้แล้ว แต่ยังอยู่ในระบบ
|
||||
- **Superseded**: ถูกแทนที่โดย ADR อื่น
|
||||
- **Rejected**: ไม่ผ่านการ Approve
|
||||
|
||||
---
|
||||
|
||||
## 📊 ADR Impact Map
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
ADR001[ADR-001<br/>Unified Workflow] --> Corr[Correspondences]
|
||||
ADR001 --> RFA[RFAs]
|
||||
ADR001 --> Circ[Circulations]
|
||||
|
||||
ADR002[ADR-002<br/>Document Numbering] --> Corr
|
||||
ADR002 --> RFA
|
||||
|
||||
ADR016[ADR-016<br/>Security & Auth] --> Auth[Authentication]
|
||||
ADR016 --> Guards[Guards]
|
||||
|
||||
ADR005[ADR-005<br/>Tech Stack] --> Backend[Backend]
|
||||
ADR005 --> Frontend[Frontend]
|
||||
ADR005 --> DB[(Database)]
|
||||
|
||||
ADR006[ADR-006<br/>Redis] --> Cache[Caching]
|
||||
ADR006 --> Lock[Locking]
|
||||
ADR006 --> Queue[Job Queue]
|
||||
ADR006 --> ADR002
|
||||
ADR006 --> ADR016
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Documentation
|
||||
|
||||
- [System Architecture](../02-architecture/02-01-system-architecture.md) - สถาปัตยกรรมระบบโดยรวม
|
||||
- [Data Model](../02-architecture/02-03-data-model.md) - โครงสร้างฐานข้อมูล
|
||||
- [API Design](../02-architecture/02-02-api-design.md) - การออกแบบ API
|
||||
- [Backend Guidelines](../03-implementation/03-02-backend-guidelines.md) - มาตรฐานการพัฒนา Backend
|
||||
- [Frontend Guidelines](../03-implementation/03-03-frontend-guidelines.md) - มาตรฐานการพัฒนา Frontend
|
||||
|
||||
---
|
||||
|
||||
## 📝 Review Process
|
||||
|
||||
### Before Merging
|
||||
|
||||
1. สร้าง ADR ใน `specs/05-decisions/ADR-XXX-title.md`
|
||||
2. Update ADR Index ใน `README.md` นี้
|
||||
3. Link ADR ไปยัง Related Documents
|
||||
4. Request Review จากทีม
|
||||
5. อภิปรายและปรับแก้ตาม Feedback
|
||||
6. Update Status เป็น "Accepted"
|
||||
7. Merge to main branch
|
||||
|
||||
### Review Checklist
|
||||
|
||||
- ☐ Context ชัดเจน เข้าใจปัญหา
|
||||
- ☐ มี Options อย่างน้อย 2-3 ทางเลือก
|
||||
- ☐ Pros/Cons ครบถ้วน
|
||||
- ☐ Decision Rationale มีเหตุผลรองรับ
|
||||
- ☐ Consequences ระบุทั้งดีและไม่ดี
|
||||
- ☐ Related ADRs linked ถูกต้อง
|
||||
- ☐ Code examples (ถ้ามี) อ่านง่าย
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Best Practices
|
||||
|
||||
### Writing Good ADRs
|
||||
|
||||
1. **Be Concise:** ไม่เกิน 3-4 หน้า (except code examples)
|
||||
2. **Focus on "Why":** อธิบายเหตุผลมากกว่า "How"
|
||||
3. **List Alternatives:** แสดงว่าพิจารณาหลายทางเลือก
|
||||
4. **Be Honest:** ระบุ Cons และ Risks จริงๆ
|
||||
5. **Use Diagrams:** Visualize ด้วย Mermaid diagrams
|
||||
6. **Link References:** ใส่ Link ไปเอกสารอ้างอิง
|
||||
|
||||
### Common Mistakes
|
||||
|
||||
- ❌ เขียนยาวเกินไป (วนเวียน)
|
||||
- ❌ ไม่มี Alternatives (แสดงว่าไม่ได้พิจารณา)
|
||||
- ❌ Consequences ไม่จริงใจ (แต่งว่าดีอย่างเดียว)
|
||||
- ❌ Implementation details มากเกินไป
|
||||
- ❌ ไม่ Update เมื่อ Decision เปลี่ยน
|
||||
|
||||
---
|
||||
|
||||
## 📚 External Resources
|
||||
|
||||
- [ADR GitHub Organization](https://adr.github.io/)
|
||||
- [Documenting Architecture Decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
|
||||
- [ADR Tools](https://github.com/npryce/adr-tools)
|
||||
- [Architecture Decision Records in Action](https://www.thoughtworks.com/insights/blog/architecture/architecture-decision-records-in-action)
|
||||
|
||||
---
|
||||
|
||||
## 📧 Contact
|
||||
|
||||
หากมีคำถามเกี่ยวกับ ADRs กรุณาติดต่อ:
|
||||
|
||||
- **System Architect:** Nattanin Peancharoen
|
||||
- **Development Team Lead:** [Name]
|
||||
|
||||
---
|
||||
|
||||
**Version:** 1.9.5 (Added ADR-023A AI Model Revision)
|
||||
**Last Review:** 2026-05-18
|
||||
**Next Review:** 2026-10-10
|
||||
|
||||
---
|
||||
|
||||
## 📚 Enhanced Documentation
|
||||
|
||||
- **[Enhanced ADR Template](./ADR-TEMPLATE-enhanced.md)** - Template ใหม่พร้อม Impact Analysis
|
||||
- **[ADR Review Process](./ADR-REVIEW-PROCESS.md)** - กระบวนการทบทวนและ Version Management
|
||||
- **[Version Dependency Matrix](./VERSION-DEPENDENCIES.md)** - ความสัมพันธ์ระหว่าง ADRs (สร้างในอนาคต)
|
||||
**Version:** 1.9.8 (Added ADR-033 Active Model & OCR Runner Management)
|
||||
**Last Review:** 2026-06-02
|
||||
**Next Review:** 2026-12-02
|
||||
|
||||
Reference in New Issue
Block a user