@relipa/ai-flow-kit 0.1.4 → 0.1.5-beta.0

package/custom/skills/test-skills/rules/Directory_and_Naming_Convention.md

@@ -1,257 +0,0 @@
-# 00. Hướng dẫn Cấu trúc Thư mục & Quy tắc Đặt tên File (Directory Structure & Naming Convention)
-
-## Mục tiêu (Objective)
-
-Định nghĩa và chuẩn hóa quy tắc tổ chức thư mục, đặt tên file cho toàn bộ các Artifact được sinh ra trong quy trình QA Workflow. Đảm bảo tính nhất quán, truy vết và dễ bảo trì trên toàn dự án.
-
-> **Lưu ý quan trọng**: Tài liệu này là **điểm tham chiếu bắt buộc** cho toàn bộ quy trình. Mọi Artifact sinh ra (Result, QA) phải tuân thủ nghiêm ngặt các quy tắc được định nghĩa tại đây trước khi thực thi bất kỳ bước nào trong workflow.
-
----
-
-## 1. Tổng quan Cấu trúc Thư mục (Directory Overview)
-
-```text
-Flow_TestCase_v1.1/
-├── Work-flow/          ← Định nghĩa quy trình (Workflow Definitions)
-│   ├── 01_Requirement_Analysis.md
-│   ├── 02_Scenario_Building.md
-│   ├── 03_Test_Design.md
-│   ├── 04_Test_Review.md
-│   ├── 05_Test_Reporting.md
-│   └── Standard_QA_Workflow.md
-│
-├── Rule/               ← Quy tắc & Quy ước chung (Rules & Standards)
-│   ├── GUI_work_flow/
-│   │   └── Directory_and_Naming_Convention.md   ← File này
-│   └── Quy_uoc_TC/
-│       └── QA_Writing_Standards.md
-│
-├── Result/             ← Kết quả chính thức của từng bước (Result Artifacts)
-│   └── {tên_SRS hoặc tên_chức_năng}/
-│       ├── 01_Requirement_Analysis_Result.md
-│       ├── 02_Test_Scenarios_Result.md
-│       ├── 03_Test_Cases_Draft_Result.md
-│       └── 04_Test_Cases_Final_Result.md
-│
-├── QA/                 ← Quản lý Issue & Câu hỏi làm rõ (QA Artifacts)
-│   └── {tên_SRS hoặc tên_chức_năng}/
-│       ├── 01_Requirement_Analysis_QA.md
-│       ├── 02_Scenario_Building_QA.md
-│       ├── 03_Test_Design_QA.md
-│       └── 04_Test_Review_QA.md
-│
-└── TestCase/           ← Bộ Test Case giao nộp theo template chuẩn (TestCase Artifacts)
-    └── {tên_SRS hoặc tên_chức_năng}/
-        └── {tên_SRS_hoặc_tên_chức_năng}_TestCase.md
-```
-
----
-
-## 2. Quy tắc thư mục `Result/` (Result Directory Rules)
-
-- **Đường dẫn gốc**: [Result/](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Result)
-- **Mục đích**: Lưu trữ toàn bộ các file kết quả chính thức (Result Artifact) được sinh ra ở mỗi bước workflow.
-
-### 2.1. Quy tắc tạo thư mục con
-
-Với mỗi tài liệu SRS hoặc tính năng được đưa vào làm đầu vào, **tạo một thư mục con** bên trong `Result/` có tên **trùng với tên tài liệu SRS hoặc tên chức năng** đó.
-
-```
-Result/
-└── {tên_tài_liệu_SRS_hoặc_tên_chức_năng}/
-```
-
-> **Ví dụ**: Nếu đầu vào là tài liệu `AD10_Create_Product`, thư mục con sẽ là:
-> `Result/AD10_Create_Product/`
-
-### 2.2. Quy tắc đặt tên file Result
-
-Tên file kết quả trong mỗi thư mục con phải tuân theo mẫu:
-
-```
-{tên_step}_Result.md
-```
-
-#### Bảng đặt tên file Result theo từng bước
-
-| Bước | Tên Step | Tên file Result |
-| :---: | :--- | :--- |
-| **01** | `01_Requirement_Analysis` | `01_Requirement_Analysis_Result.md` |
-| **02** | `02_Test_Scenarios` | `02_Test_Scenarios_Result.md` |
-| **03** | `03_Test_Cases_Draft` | `03_Test_Cases_Draft_Result.md` |
-| **04** | `04_Test_Cases_Final` | `04_Test_Cases_Final_Result.md` |
-
-#### Ví dụ đường dẫn đầy đủ
-
-```
-Result/AD10_Create_Product/01_Requirement_Analysis_Result.md
-Result/AD10_Create_Product/02_Test_Scenarios_Result.md
-Result/AD10_Create_Product/03_Test_Cases_Draft_Result.md
-Result/AD10_Create_Product/04_Test_Cases_Final_Result.md
-```
-
----
-
-## 3. Quy tắc thư mục `QA/` (QA Directory Rules)
-
-- **Đường dẫn gốc**: [QA/](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/QA)
-- **Mục đích**: Lưu trữ toàn bộ các file ghi nhận Issue, câu hỏi làm rõ và giả định phát sinh trong từng bước workflow.
-
-### 3.1. Quy tắc tạo thư mục con
-
-Tương tự thư mục `Result/`, với mỗi tài liệu SRS hoặc tính năng được đưa vào, **tạo một thư mục con** bên trong `QA/` có tên **trùng với tên tài liệu SRS hoặc tên chức năng** đó.
-
-```
-QA/
-└── {tên_tài_liệu_SRS_hoặc_tên_chức_năng}/
-```
-
-> **Ví dụ**: Nếu đầu vào là tài liệu `AD10_Create_Product`, thư mục con sẽ là:
-> `QA/AD10_Create_Product/`
-
-### 3.2. Quy tắc đặt tên file QA
-
-Tên file QA trong mỗi thư mục con phải tuân theo mẫu:
-
-```
-{tên_step}_QA.md
-```
-
-#### Bảng đặt tên file QA theo từng bước
-
-| Bước | Tên Step | Tên file QA |
-| :---: | :--- | :--- |
-| **01** | `01_Requirement_Analysis` | `01_Requirement_Analysis_QA.md` |
-| **02** | `02_Scenario_Building` | `02_Scenario_Building_QA.md` |
-| **03** | `03_Test_Design` | `03_Test_Design_QA.md` |
-| **04** | `04_Test_Review` | `04_Test_Review_QA.md` |
-
-#### Ví dụ đường dẫn đầy đủ
-
-```
-QA/AD10_Create_Product/01_Requirement_Analysis_QA.md
-QA/AD10_Create_Product/02_Scenario_Building_QA.md
-QA/AD10_Create_Product/03_Test_Design_QA.md
-QA/AD10_Create_Product/04_Test_Review_QA.md
-```
-
----
-
-## 4. Quy tắc thư mục `TestCase/` (TestCase Directory Rules)
-
-- **Đường dẫn gốc**: [TestCase/](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/TestCase)
-- **Mục đích**: Lưu trữ bộ Test Case giao nộp cuối cùng theo đúng template chuẩn dự án. File này chỉ chứa **phần bảng Test Case** (không chứa review summary, findings hay coverage validation) và được sinh **đồng thời** với `04_Test_Cases_Final_Result.md` ở cuối Bước 04.
-
-### 4.1. Quy tắc tạo thư mục con
-
-Tương tự `Result/` và `QA/`, với mỗi tài liệu SRS hoặc tính năng, **tạo một thư mục con** bên trong `TestCase/` có tên **trùng với tên tài liệu SRS hoặc tên chức năng** đó.
-
-```
-TestCase/
-└── {tên_tài_liệu_SRS_hoặc_tên_chức_năng}/
-```
-
-> **Ví dụ**: Nếu đầu vào là tài liệu `AD06_Create_Tag`, thư mục con sẽ là:
-> `TestCase/AD06_Create_Tag/`
-
-### 4.2. Quy tắc đặt tên file TestCase
-
-Tên file TestCase trong mỗi thư mục con phải tuân theo mẫu:
-
-```
-{tên_SRS_hoặc_tên_chức_năng}_TestCase.md
-```
-
-| Thành phần | Mô tả |
-| :--- | :--- |
-| `{tên_SRS_hoặc_tên_chức_năng}` | Trùng khớp với tên thư mục con (không rút gọn, không thay đổi) |
-| `_TestCase` | Hậu tố cố định, phân biệt với Result và QA artifact |
-| `.md` | Định dạng Markdown |
-
-#### Ví dụ đường dẫn đầy đủ
-
-```
-TestCase/AD06_Create_Tag/AD06_Create_Tag_TestCase.md
-TestCase/AD10_Create_Product/AD10_Create_Product_TestCase.md
-```
-
-### 4.3. Nội dung file TestCase
-
-File TestCase tuân theo **template chuẩn** tại [Template/template_testcase.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Template/template_testcase.md) và **chỉ bao gồm**:
-
-- Mục **1. Thông tin chung** (General Info)
-- Mục **2. Kết quả kiểm thử tổng hợp** (Test Execution Summary)
-- Mục **3. Danh sách Test Cases Chi Tiết** (Detailed Test Cases — toàn bộ các nhóm và bảng test case)
-
-> **Không bao gồm**: Review Summary, Review Findings, Coverage Validation (RTM), Sign-off Status — các mục này thuộc về `04_Test_Cases_Final_Result.md`.
-
-### 4.4. Thời điểm sinh file
-
-File TestCase được sinh **đồng thời** với `04_Test_Cases_Final_Result.md` tại cuối Bước 04 (Test Review), khi tất cả issue Critical/Major đã được giải quyết và bộ Test Case đã Sign-off.
-
----
-
-## 5. Artifact Matrix Tổng hợp (Full Artifact Matrix)
-
-Bảng tổng hợp đầy đủ mapping giữa các bước workflow và các Artifact tương ứng:
-
-| Step | Mô tả | Result Artifact | QA Artifact | TestCase Artifact | Storage |
-| :---: | :--- | :--- | :--- | :--- | :--- |
-| **01** | Phân tích Yêu cầu & Rủi ro | `01_Requirement_Analysis_Result.md` | `01_Requirement_Analysis_QA.md` | — | `Result/{tên}/` và `QA/{tên}/` |
-| **02** | Xây dựng Kịch bản (Scenario) | `02_Test_Scenarios_Result.md` | `02_Scenario_Building_QA.md` | — | `Result/{tên}/` và `QA/{tên}/` |
-| **03** | Thiết kế Test Case chi tiết | `03_Test_Cases_Draft_Result.md` | `03_Test_Design_QA.md` | — | `Result/{tên}/` và `QA/{tên}/` |
-| **04** | Review & Tối ưu hóa | `04_Test_Cases_Final_Result.md` | `04_Test_Review_QA.md` | `{tên}_TestCase.md` | `Result/{tên}/`, `QA/{tên}/` và `TestCase/{tên}/` |
-
----
-
-## 6. Quy tắc bổ sung (Additional Rules)
-
-### 6.1. Quy tắc cập nhật file (Update Rule)
-
-- Nếu file đã tồn tại, **cập nhật và ghi đè** nội dung mới nhất.
-- **Không tạo file trùng lặp** với hậu tố phiên bản (ví dụ: `_v1`, `_v2`, `_final`, `_new`).
-
-### 6.2. Quy tắc đặt tên thư mục con (Subdirectory Naming)
-
-- Sử dụng **đúng tên** của tài liệu SRS hoặc tên chức năng được đưa vào (không tự ý rút gọn hoặc thay đổi).
-- Ví dụ hợp lệ: `AD10_Create_Product`, `Login_Feature`, `AD06_Create_Tag`.
-- Ví dụ **không hợp lệ**: `product`, `login`, `tag_feature` (tên tự đặt khác với tên gốc).
-
-### 6.3. Nguyên tắc nhất quán (Consistency Principle)
-
-- Thư mục con trong `Result/`, `QA/` và `TestCase/` **phải có cùng tên** với nhau cho một tài liệu SRS/chức năng.
-- Điều này đảm bảo việc tra cứu và truy vết giữa Result, QA và TestCase là nhanh chóng và chính xác.
-
----
-
-## 7. Checklist Áp dụng (Application Checklist)
-
-Trước khi bắt đầu thực thi bất kỳ bước nào trong workflow, kiểm tra:
-
-- [ ] Đã xác định đúng tên tài liệu SRS / tên chức năng đầu vào chưa?
-- [ ] Đã tạo thư mục con trong `Result/` với đúng tên chưa?
-- [ ] Đã tạo thư mục con trong `QA/` với đúng tên (trùng với `Result/`) chưa?
-- [ ] Tên file Result tuân theo mẫu `{tên_step}_Result.md` chưa?
-- [ ] Tên file QA tuân theo mẫu `{tên_step}_QA.md` chưa?
-- [ ] (Sau Bước 04) Đã tạo thư mục con trong `TestCase/` với đúng tên chưa?
-- [ ] (Sau Bước 04) Tên file TestCase tuân theo mẫu `{tên_SRS_hoặc_tên_chức_năng}_TestCase.md` chưa?
-- [ ] (Sau Bước 04) File TestCase chỉ chứa phần bảng test case theo template chuẩn, không chứa review metadata chưa?
-- [ ] Không có file trùng lặp hoặc sai quy tắc đặt tên không?
-
----
-
-## 8. Liên kết tham chiếu (References)
-
-- [Standard_QA_Workflow.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Work-flow/Standard_QA_Workflow.md) — Tổng quan quy trình làm việc chuẩn.
-- [01_Requirement_Analysis.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Work-flow/01_Requirement_Analysis.md) — Chi tiết Bước 1.
-- [02_Scenario_Building.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Work-flow/02_Scenario_Building.md) — Chi tiết Bước 2.
-- [03_Test_Design.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Work-flow/03_Test_Design.md) — Chi tiết Bước 3.
-- [04_Test_Review.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Work-flow/04_Test_Review.md) — Chi tiết Bước 4.
-- [Result/](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Result) — Thư mục lưu Result Artifacts.
-- [QA/](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/QA) — Thư mục lưu QA Artifacts.
-- [TestCase/](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/TestCase) — Thư mục lưu TestCase Artifacts theo template chuẩn.
-- [Template/template_testcase.md](file:///home/lee/Documents/Projects/Flow_TestCase_v1.1/Template/template_testcase.md) — Template chuẩn cho file TestCase.
-
----
-
-*Tài liệu này là quy tắc nền tảng của hệ thống. Mọi thay đổi về cấu trúc thư mục hoặc quy tắc đặt tên phải được cập nhật tại đây trước khi áp dụng.*