Quy ước viết

Trạng thái trang (`status` trong frontmatter)

Giá trị	Nghĩa
`stub`	Mới có khung, chưa có nội dung
`draft`	Đang viết, hoặc tóm từ BRD chưa duyệt
`reviewed`	Đã có người thứ hai (Dev/Tester/BA khác) rà
`approved`	Khớp BRD đã được khách duyệt

Frontmatter của trang chức năng

---
title: "Repair / Rework"
description: "Một câu nói chức năng làm gì."
module: MES                       # MES | WMS | …
status: draft
flow: mes/repair-rework           # slug trên flow site
brd: "FC_BRD_RepairRework_v0.2_20261013.docx"   # BRD làm căn cứ; trống nếu chưa có
owner: "BA dự án FC"              # vai trò chịu trách nhiệm, không ghi tên riêng
---

Đặt mã

Loại	Dạng	Ví dụ
Business rule	`BR-<MÃ CHỨC NĂNG>-nn`	`BR-RW-05`
Yêu cầu chức năng	`FR-<MÃ>-nn`	`FR-RW-04`
Kịch bản nghiệm thu	`AC-nn` (trong trang)	`AC-06`
Câu hỏi mở	`OQ-<MÃ>-nn`	`OQ-RW-03`
Quyết định của user	`Q-YYYYMMDD-nn` (từ nhật ký hỏi–đáp)	`Q-20261013-01`

Mã chức năng lấy theo BRD (Repair / Rework = RW). Chưa có BRD thì BA đặt và ghi vào trang.
Không đổi, không dùng lại mã đã có. Bỏ một luật thì giữ dòng, gạch và ghi lý do: ~~BR-RW-04 …~~ (bỏ 20/10/2026, Q-…). Dev và Tester đã trích mã vào code và test case; đổi số là gãy truy vết.
Một mã BR-… chỉ được định nghĩa ở một trang. Bộ kiểm báo lỗi khi trùng.

Ghi nguồn, tách quan sát khỏi suy luận

Mỗi ghi chú Dev/Test nói một điều về hệ thống phải cho biết thấy ở đâu, ngày nào:

Loại	Viết thế nào
Quan sát	“Trên DEV (10.0.68.230:3011), 13/10/2026: bấm Save khi Qty = 0 không báo lỗi.”
Theo tài liệu	“Theo BRD v0.2 mục 6.5 …”
Suy luận	“Suy ra từ … — chưa ai xác nhận.”

Không trộn quan sát và suy luận trong cùng một câu.
Số liệu ghi kèm mẫu số và nguồn: “9/2.351 dòng, truy vấn DEV 07/10/2026”, không viết “rất ít”.

Trích nguyên văn

Nhãn field, tên nút, thông báo lỗi chép đúng như trên màn hình, đặt trong backtick, kể cả khi sai chính tả. Không tự sửa cho đẹp — thấy sai thì thêm một dòng vào mục Câu hỏi mở.

Khi trang này và BRD nói khác nhau

BRD là căn cứ chính thức cho tới khi BA cập nhật. Đừng lặng lẽ sửa luật trong kho cho khớp với code — thêm câu hỏi vào mục 10 và báo BA.

Thuật ngữ

Dùng đúng từ trong Thuật ngữ. Ví dụ trên màn WMS, lệnh sản xuất ghi nhãn Work Instruction, không dùng Production Order.