151 lines
5.2 KiB
Markdown
151 lines
5.2 KiB
Markdown
# DREV — Design Review Log — <PROJECT>
|
||
|
||
| | |
|
||
|---|---|
|
||
| **Cập nhật** | YYYY-MM-DD |
|
||
| **Author** | <SA> (skill sa-3-enablement) |
|
||
| **Scope** | |
|
||
|
||
> **Đây là sổ sống** — ghi thêm liên tục, không lên version, không archive. Mục cũ không bao
|
||
> giờ sửa; sai thì thêm mục mới tham chiếu ngược.
|
||
|
||
---
|
||
|
||
## 1. Tóm tắt
|
||
|
||
| Trạng thái | Số mục |
|
||
|---|---|
|
||
| Đang chờ SA (⏳) | |
|
||
| Đã kết luận, đang thực hiện | |
|
||
| Đã đóng | |
|
||
| Sinh ra `ADR` mới | |
|
||
| Sinh ra `TD` | |
|
||
|
||
**Thời gian chờ trung bình:** … ngày · **mục tiêu: ≤ 2 ngày làm việc**
|
||
|
||
🔴 Chờ lâu hơn 2 ngày thì dev sẽ đi tiếp mà không chờ — và review thành phê bình sau khi đã
|
||
code xong: vô ích và gây mâu thuẫn.
|
||
|
||
## 2. Nhật ký
|
||
|
||
### DREV-nnn — <tiêu đề ngắn>
|
||
|
||
| | |
|
||
|---|---|
|
||
| **Ngày nhận** | |
|
||
| **Người hỏi** | |
|
||
| **Loại** | ❓ câu hỏi làm rõ · 🔧 đề xuất thay đổi thiết kế · ⚠️ phát hiện thiết kế sai |
|
||
| **Trạng thái** | ⏳ chờ SA · 🔄 đang thực hiện · ✅ đóng |
|
||
| **Ngày kết luận** | |
|
||
|
||
**Bối cảnh** — *(dev mô tả gì, đang gặp vấn đề gì thật)*
|
||
|
||
**Điểm radar** *(theo `../../sa-lifecycle/references/decision-radar.md` §2)*
|
||
|
||
| Tiêu chí | Điểm | Lý do |
|
||
|---|---|---|
|
||
| Chi phí đảo ngược | | |
|
||
| Bán kính ảnh hưởng | | |
|
||
| Chạm thuộc tính chất lượng | | |
|
||
| Ràng buộc dài hạn | | |
|
||
| Tranh cãi | | |
|
||
| **Tổng** | /10 | ⇒ *(0–2 trả Tech Lead · 3–4 `DEC` · 5–7 `ADR` · 8–10 `ADR` + POC)* |
|
||
|
||
**Đối chiếu thiết kế**
|
||
|
||
| Tài liệu | Nội dung liên quan | Có mâu thuẫn không |
|
||
|---|---|---|
|
||
| `ADR-nnn` | | |
|
||
| `QAS-nnn` | | |
|
||
| `SAD` §… | | |
|
||
|
||
**Phương án** — *(≥ 2, kể cả khi dev chỉ đưa 1. Phần lớn giá trị của review nằm ở đây.)*
|
||
|
||
| # | Phương án | Ưu | Nhược | Chi phí |
|
||
|---|---|---|---|---|
|
||
| 1 | | | | |
|
||
| 2 | | | | |
|
||
|
||
**Kết luận** — chọn đúng một trong bốn:
|
||
|
||
- [ ] ✅ **Đúng thiết kế** — không cần làm gì
|
||
- [ ] 🟡 **Lệch nhưng chấp nhận được** ⇒ `TD-nn`, hạn …
|
||
- [ ] 🔴 **Lệch phải sửa** ⇒ việc: …, chủ: …, hạn: …
|
||
- [ ] ⚠️ **Thiết kế sai, cần `ADR` mới** ⇒ `ADR-nnn` (`Supersedes: ADR-nnn`)
|
||
|
||
**Người quyết · ngày:** …
|
||
|
||
**Việc phát sinh**
|
||
|
||
| Việc | Chủ | Hạn | Ghi ở đâu |
|
||
|---|---|---|---|
|
||
|
||
---
|
||
|
||
### DREV-nnn — <tiêu đề>
|
||
|
||
*(cùng cấu trúc)*
|
||
|
||
---
|
||
|
||
## 3. Mẫu tham khảo — một mục đã hoàn chỉnh
|
||
|
||
### DREV-012 — Gọi thẳng CSDL module Order từ module Report
|
||
|
||
| | |
|
||
|---|---|
|
||
| **Ngày nhận** | 2026-09-12 |
|
||
| **Người hỏi** | anh Nam (dev) |
|
||
| **Loại** | 🔧 đề xuất thay đổi thiết kế |
|
||
| **Trạng thái** | ✅ đóng |
|
||
| **Ngày kết luận** | 2026-09-13 |
|
||
|
||
**Bối cảnh** — Báo cáo tổng hợp cần join 3 bảng của module Order. Gọi qua interface công khai
|
||
mất 4,1 giây, vượt `QAS-003` (p95 ≤ 3s). Dev đề xuất truy vấn thẳng CSDL của Order.
|
||
|
||
**Điểm radar: 8/10** — chi phí đảo ngược 1 · bán kính 2 · chạm `QAS` 2 · ràng buộc dài hạn 2 ·
|
||
tranh cãi 1 ⇒ cần `ADR`, không quyết trong PR.
|
||
|
||
**Đối chiếu:** `ADR-004` chốt module chỉ giao tiếp qua interface công khai. `QAS-003` yêu cầu
|
||
p95 ≤ 3s — **thiết kế hiện tại không đạt**. Dev đúng về vấn đề, sai về cách giải.
|
||
|
||
**Phương án**
|
||
|
||
| # | Phương án | Ưu | Nhược | Chi phí |
|
||
|---|---|---|---|---|
|
||
| 1 | Giữ ranh giới + read model riêng cho báo cáo | Đúng `ADR-004`, mở đường tách service | Thêm cơ chế đồng bộ | +1 tuần |
|
||
| 2 | Giữ ranh giới + cache kết quả | Rẻ nhất, +2 ngày | Dữ liệu trễ ≤ 5 phút | +2 ngày |
|
||
| 3 | Gọi thẳng CSDL | Nhanh nhất | Vi phạm `ADR-004`, chặn việc tách service sau này | +0 |
|
||
| 4 | Nới `QAS-003` lên 5s | Không phải làm gì | Cần PO chấp nhận | +0 |
|
||
|
||
**Kết luận:** ⚠️ hỏi PO trước (`OQ-034`: báo cáo trễ 5 phút có chấp nhận được không).
|
||
PO trả lời 2026-09-13: chấp nhận ⇒ chọn **PA-2**.
|
||
|
||
**Người quyết:** SA + Tech Lead, sau khi PO trả lời `OQ-034` · 2026-09-13
|
||
|
||
**Việc phát sinh**
|
||
|
||
| Việc | Chủ | Hạn | Ghi ở đâu |
|
||
|---|---|---|---|
|
||
| Bổ sung `QAS-003` ghi rõ "dữ liệu báo cáo trễ ≤ 5 phút" | SA | 2026-09-15 | `QAS` v1.1 |
|
||
| Ghi `DEC-07` về mức trễ chấp nhận được | SA | 2026-09-15 | `00-index/DEC` |
|
||
| Cài cache + cơ chế làm mới | anh Nam | 2026-09-19 | |
|
||
|
||
---
|
||
|
||
## 4. Câu hỏi lặp lại ⇒ tài liệu chưa rõ
|
||
|
||
*Cùng một câu hỏi từ ≥ 2 người ⇒ không phải lỗi của dev, là lỗi của tài liệu.*
|
||
|
||
| Câu hỏi | Số lần bị hỏi | Tài liệu phải sửa | Đã sửa |
|
||
|---|---|---|---|
|
||
| | | `AGD` §… / `ICD` §… | ☐ |
|
||
|
||
## 5. Phản hồi "kiến trúc không thực tế"
|
||
|
||
*Cùng một phản hồi về cùng một chỗ, ≥ 3 lần ⇒ khả năng cao thiết kế sai thật.*
|
||
|
||
| Chỗ bị phản hồi | Số lần | Ai | Đã đánh giá lại | Kết luận |
|
||
|---|---|---|---|---|
|
||
| | | | ☐ | |
|