# Skill: Template Đặc tả Use Case (Use Case Spec) - Phiên bản v1 Cấu trúc chuẩn của một tài liệu đặc tả Use Case hoàn chỉnh dùng để chuyển giao cho Dev/Test. --- # Tài liệu Đặc Tả Use Case: Chức năng [Tên Chức Năng] **UC-Spec-Version:** v{N} **Date:** [YYYY-MM-DD] **Status:** ⏸️ Waiting for PM sign-off | ✅ PM Approved > Header này là điểm neo cho toàn bộ chuỗi trace ngược (System Requirement, Test Case) — xem `docs/internal/Token Problems.md` §3.1. Trước đây template này không có version header, khiến mọi công cụ downstream (`create-system-requirement`, `create-testcase`) không có cách nào xác định UC Spec đang ở version nào một cách tường minh. ## 1. Thông tin chung (General Information) | Thuộc tính | Mô tả chi tiết | | :--- | :--- | | **Tên chức năng (Function Name)** | [Tên chức năng chính xác] | | **Mô tả (Description)** | [Tóm tắt mục đích và giá trị nghiệp vụ của chức năng] | | **Tác nhân (Actors)** | [Danh sách các tác nhân sử dụng hoặc bị tác động] | | **Tác nhân kích hoạt (Trigger)** | [Sự kiện kích hoạt luồng xử lý này] | | **Điều kiện tiên quyết (Pre-Conditions)** | [Các điều kiện hệ thống hoặc trạng thái dữ liệu bắt buộc phải có trước khi thực hiện] | | **Điều kiện sau xử lý (Post-Conditions)** | [Trạng thái của hệ thống và dữ liệu sau khi kết thúc thành công] | ### Luồng xử lý chính (Main Flow) | Bước | Tác nhân (Actor Action) | Hệ thống (System Response) | | :-: | :--- | :--- | | 1 | Người dùng kích hoạt sự kiện... | Hệ thống hiển thị giao diện... | | 2 | Người dùng nhập các thông tin... | | | 3 | Người dùng nhấn nút... | Hệ thống kiểm tra và thực hiện... | | 4 | | Hệ thống thông báo thành công và chuyển hướng... | ### Các luồng thay thế / ngoại lệ (Alternative / Exception Flows) - **Alternative Flow A: [Tên luồng thay thế]** - Thực hiện từ bước [X] của Luồng chính: - Các bước xử lý: ... - **Exception Flow B: [Tên luồng lỗi]** - Thực hiện khi xảy ra lỗi: ... - Các bước xử lý: ... --- ## 2. Mô tả màn hình (Screen Description) *Nhúng code HTML của màn hình prototype hoặc ảnh chụp mockup tại đây:* ```html ``` --- ## 3. Mô tả thành phần giao diện (UI Components Description) | # | Tên Component | Loại Component | Cho phép sửa | Bắt buộc | Giá trị mặc định | Quy tắc định dạng & Giới hạn dữ liệu | Mô tả hành vi & tương tác | | :-: | :--- | :--- | :-: | :-: | :--- | :--- | :--- | | 1 | `ログインID` | Textbox | Yes | Yes | None | Độ dài: 3-20 ký tự. Chỉ chữ và số. Không chứa khoảng trắng. | Ô nhập tên tài khoản của người dùng. | | 2 | `ログイン` | Button | N/A | N/A | N/A | N/A | Nhấn để gửi thông tin đăng nhập lên hệ thống. | | 3 | | | | | | | | --- ## 4. Sơ đồ luồng hoạt động (Activity Flow Diagram) *Sử dụng biểu đồ Mermaid để trực quan hóa quy trình xử lý.* ```mermaid graph TD %% Viết mã nguồn Mermaid tại đây ``` --- ## 5. Quy tắc nghiệp vụ (Business Rules) ### BR1: Quy tắc kiểm tra dữ liệu đầu vào (Validation Rules) *Định nghĩa các lỗi khi người dùng nhập dữ liệu sai hoặc để trống.* - **[BR1.1] Trống dữ liệu bắt buộc:** Nếu bất kỳ trường bắt buộc nào bị trống khi nhấn nút thực thi: - Hệ thống dừng xử lý. - Hiển thị lỗi tương ứng: `[Tên thông báo lỗi]` dưới ô nhập liệu bị trống. - **[BR1.2] Định dạng dữ liệu không hợp lệ:** ... ### BR2: Quy tắc lưu trữ dữ liệu (Saving Rules) *Định nghĩa cách dữ liệu được ghi nhận vào cơ sở dữ liệu.* - **[BR2.1]** Hệ thống ghi nhận thời gian đăng nhập vào bảng `user_logs` với các trường: `user_id`, `login_time`, `status`. ### BR3: Quy tắc phân quyền & Bảo mật (Authorization & Security Rules) - **[BR3.1]** Sau 5 lần nhập sai mật khẩu liên tiếp, tài khoản tự động bị khóa trong 30 phút. --- ## 6. Change Log *Chỉ điền khi Mode UPDATE (version ≥ v2) — Mode CREATE (v1) để trống hoặc ghi 1 dòng "Khởi tạo ban đầu".* Mỗi thay đổi giữa 2 version phải có 1 dòng — không âm thầm sửa nội dung mà không ghi lại (xem `custom/templates/shared/create-spec-workflow.md` Gate 4 Bước 1). | Version | Ngày | Flow/BR/UI Component thay đổi | Tóm tắt thay đổi | Nguồn (ticket/CR) | |---|---|---|---|---| | v1 | [YYYY-MM-DD] | — | Khởi tạo ban đầu | [ticket gốc] |