Hướng dẫn viết

Quy ước chung để nhiều người cùng viết mà tài liệu vẫn đọc như một.

Nhận và trả việc

  1. PM điền owner, reviewer, due cho trang trong assets/manifest.js.
  2. Người viết đổi status sang "dang-viet", đọc Mục tiêu & phạm vi và Thuật ngữ.
  3. Sửa bản nháp: xác nhận hoặc thay từng nhãn , điền ….
  4. Khi trang không còn nhãn giả định: đổi status sang "review", báo reviewer.
  5. Reviewer góp ý trực tiếp (comment PR hoặc ghi vào mục Câu hỏi mở). Đạt → reviewer đổi sang "da-chot", bản 1.0.
Một người — một fileChỉ sửa trang mình phụ trách và dòng của mình trong manifest. Cần sửa trang người khác: ghi vào mục Câu hỏi mở của trang đó hoặc báo người viết.

Cấu trúc trang

Trang module giữ đúng thứ tự mục của trang mẫu. Trang tổng quan, kênh, phi chức năng được bỏ mục không hợp, nhưng luôn giữ Câu hỏi mở và Lịch sử thay đổi.

MụcTrả lời câu hỏi
Mục tiêuLàm để đạt gì, đo bằng gì, không làm gì
Vai trò & quyềnAi được làm gì
User storiesNhu cầu từng vai trò, ưu tiên
Luồng chínhCác bước theo thứ tự
Màn hìnhMàn nào, có gì, bấm gì
Quy tắc nghiệp vụĐiều kiện, giới hạn, công thức
Trường dữ liệuLưu gì, kiểu, ràng buộc
Trạng tháiVòng đời đối tượng, ai chuyển
Ngoại lệ & lỗiHỏng thì sao, báo người dùng gì
Tiêu chí nghiệm thuQA kiểm gì để đóng

Văn phong

Quy tắcNênKhông nên
Bảng trước văn xuôiLiệt kê quy tắc thành bảng có mãĐoạn văn dài nhiều điều kiện
Kiệm chữ"Mỗi SĐT tối đa 3 lượt/ngày.""Hệ thống sẽ cần phải đảm bảo rằng mỗi số điện thoại…"
Đo được"Phản hồi ≤ 300 ms ở p95""Nhanh", "mượt", "thân thiện"
Một ý một nơiLink sang trang chủ quảnChép lại quy tắc của trang khác
Tiếng ViệtGiữ thuật ngữ quen: campaign, booth, voucher, OTPDịch gượng ("chiến dịch kích hoạt ngoại tuyến")
Tên gọiĐúng bảng Thuật ngữTự đặt tên mới ("giải thưởng", "phần quà" lẫn lộn)
Tiêu chí nghiệm thu"Cho … khi … thì …""Chức năng hoạt động đúng"

Kỹ thuật

ViệcCách làm
Thêm trangCopy _mau/trang-mau.html → thêm 1 dòng vào manifest.js
Mở xemMở thẳng file HTML trong trình duyệt, hoặc chạy python3 -m http.server ở thư mục gốc dự án rồi vào /docs/
Số mục, mục lục, menuTự sinh — chỉ viết <section id><h2>
ẢnhĐặt cạnh trang trong thư mục img/ của nhóm, định dạng WebP/PNG, ≤ 300 KB
MockupDẫn link Figma hoặc màn mẫu trong design/templates/; không dán ảnh chụp lớn
Màu, chữ, componentChỉ dùng lớp .doc-*, .ds-* có sẵn. Không viết style=""
GitMỗi trang một nhánh/PR; tiêu đề PR: docs(<MOD>): …

Lịch sử thay đổi

BảnNgàyNgười sửaNội dung
0.12026-11-11PMKhởi tạo