HỆ THỐNG QUẢN LÝ VÀ PHÁT HÀNH ĐẶC TẢ YÊU CẦU PHẦN MỀM (SRS MANAGER) (SRSMANAGER)
1.1 Mục đích:
Tài liệu này xác định toàn bộ yêu cầu nghiệp vụ, yêu cầu chức năng, phi chức năng, kiến trúc kỹ thuật và thiết kế dữ liệu cho Hệ thống Quản lý Đặc tả Yêu cầu SRS Manager. Tài liệu là căn cứ pháp lý và kỹ thuật cho việc xây dựng, kiểm thử, nghiệm thu và vận hành hệ thống tại CÔNG TY TNHH ĐẦU TƯ QF.
1.2 Tóm tắt phạm vi:
SRS Manager cung cấp giải pháp chuyển đổi số toàn diện cho công tác quản trị yêu cầu: Quản lý danh mục dự án, soạn thảo yêu cầu FR/NFR, xây dựng kịch bản Use Case, thiết kế mô hình dữ liệu ERD, đính kèm media/sơ đồ kiến trúc, cơ chế thẩm định nhận xét chi tiết theo từng thành phần, ma trận truy vết Traceability và phát hành tài liệu Word BM01 tự động.
Phạm vi chi tiết (In / Out Scope):
-
IN Quản lý vòng đời tài liệu SRS từ Dự thảo (Draft), Thẩm định (In Review), Phê duyệt (Approved) đến Đóng băng (Baselined).
-
IN Quản lý đa dự án, phân quyền thành viên theo vai trò (Author, Reviewer, Approver, Viewer).
-
IN Soạn thảo và phân cấp Yêu cầu Chức năng (FR) và Phi chức năng (NFR) theo chuẩn ISO/IEC 29148.
-
IN Đặc tả chi tiết Kịch bản Use Case gồm Luồng chính (Main flow), Luồng nhánh (Alternate) và Ngoại lệ (Exception).
-
IN Quản lý Từ điển Dữ liệu (Data Dictionary): Định nghĩa Bảng thực thể, Thuộc tính, Khóa chính, Ràng buộc, Chỉ mục và Quan hệ 1:1, 1:N, N:M.
-
IN Quản lý Sơ đồ Kiến trúc, ERD, Use Case và Hình ảnh giao diện thực tế (Screenshots) đính kèm.
-
IN Tính năng Thẩm định Nhận xét theo từng thành phần (Component Review) trên Requirement, Use Case, Entity và Sơ đồ.
-
IN Tích hợp Link bản chạy thử (Live Demo URL) và liên kết công cụ quản lý dự án Jira.
-
IN Xem trước toàn diện giao diện tài liệu (Preview Mode) và Xuất tài liệu Word chuẩn BM01.QT.QF_SRS.
-
OUT Tự động sinh mã nguồn Backend/Frontend từ mô hình ERD và Use Case (thuộc phạm vi giai đoạn 2).
-
OUT Tích hợp ký số điện tử CA / HSM tập trung (sẽ được bổ sung trong bản phát hành v2.0).
| Thuật ngữ | Tên đầy đủ | Ý nghĩa | Thao tác |
|---|---|---|---|
| SRS | Software Requirements Specification | Tài liệu đặc tả yêu cầu phần mềm mô tả toàn diện chức năng, phi chức năng và giao diện của hệ thống. | |
| FR | Functional Requirement | Yêu cầu chức năng mô tả các hành vi, nghiệp vụ cụ thể mà hệ thống phải thực hiện cho người dùng. | |
| NFR | Non-Functional Requirement | Yêu cầu phi chức năng mô tả các tiêu chuẩn chất lượng (hiệu năng, bảo mật, độ sẵn sàng, khả năng chịu tải). | |
| UC | Use Case | Trường hợp sử dụng mô tả chuỗi tương tác giữa Actor và hệ thống để đạt được một mục tiêu nghiệp vụ cụ thể. | |
| ERD | Entity Relationship Diagram | Sơ đồ quan hệ thực thể mô tả cấu trúc các bảng dữ liệu, thuộc tính và mối quan hệ giữa các thực thể. | |
| Baseline | Configuration Baseline | Trạng thái tài liệu đã được phê duyệt chính thức và đóng băng, mọi thay đổi sau đó phải thông qua quy trình Change Request. | |
| BA | Business Analyst | Chuyên viên phân tích nghiệp vụ chịu trách nhiệm thu thập, phân tích và soạn thảo tài liệu đặc tả. | |
| QA/QC | Quality Assurance / Control | Đội ngũ đảm bảo chất lượng chịu trách nhiệm thẩm định tài liệu SRS và kiểm thử phần mềm. | |
| Traceability Matrix | Requirements Traceability Matrix (RTM) | Ma trận truy vết bảo đảm mỗi yêu cầu đều ánh xạ tới nhu cầu kinh doanh (Business Need), Use Case và Test Case. | |
| Component Review | Component-Level Review | Cơ chế nhận xét và phản hồi được gắn trực tiếp vào từng thành phần nhỏ của tài liệu (Yêu cầu, Use Case, Bảng dữ liệu). | |
| Demo URL | Live Prototype / Demo URL | Đường dẫn trực tiếp đến phiên bản chạy thử hoặc bản mẫu tương tác của sản phẩm để phục vụ thẩm định. | |
| EF Core | Entity Framework Core | Khung ánh xạ đối tượng - cơ sở dữ liệu (ORM) hiện đại cho .NET dùng để tương tác với SQL Server. |
| Mã | Tên tài liệu | Liên kết (URL) | Thao tác |
|---|---|---|---|
| REF-01 | Tiêu chuẩn quốc tế ISO/IEC/IEEE 29148:2018 về Kỹ nghệ Yêu cầu | https://www.iso.org/standard/72089.html | |
| REF-02 | Quy trình Quản lý Dự án & Phát triển Phần mềm CÔNG TY TNHH ĐẦU TƯ QF (BM01.QT.QF) | - | |
| REF-03 | Tài liệu Kiến trúc Kỹ thuật Microsoft ASP.NET Core & Entity Framework Core | https://learn.microsoft.com/aspnet/core |
| Loại | Nội dung | Thao tác |
|---|---|---|
| CONSTRAINT | Hệ thống phải hoạt động ổn định trên nền tảng .NET 8 LTS và máy chủ cơ sở dữ liệu Microsoft SQL Server 2019+. | |
| CONSTRAINT | Toàn bộ giao diện người dùng phải tuân thủ bảng mã tiếng Việt chuẩn Unicode UTF-8, không bị lỗi font trên mọi trình duyệt hiện đại. | |
| CONSTRAINT | Tài liệu Word xuất bản phải đạt chuẩn định dạng BM01.QT.QF của CÔNG TY TNHH ĐẦU TƯ QF (font Segoe UI/Calibri, bảng biểu chuẩn mực, có trang bìa và mục lục). | |
| ASSUMPTION | Đội ngũ thẩm định và quản trị viên sử dụng các trình duyệt chuẩn như Chrome, Edge, Firefox để thao tác trên hệ thống. | |
| DEPENDENCY | Hạ tầng mạng nội bộ hoặc đám mây của CÔNG TY TNHH ĐẦU TƯ QF đáp ứng kết nối thông suốt giữa Web Server và SQL Server. |
| Tác nhân | Mô tả vai trò | Quyền hạn | Xóa |
|---|---|---|---|
| Business Analyst (BA) | Chuyên viên phân tích nghiệp vụ phụ trách khảo sát, soạn thảo yêu cầu, Use Case và từ điển dữ liệu. | Tạo mới, chỉnh sửa tài liệu SRS, cập nhật FR/NFR, xây dựng Use Case, thiết kế ERD, phản hồi nhận xét. | |
| Project Manager (PM) | Quản lý dự án phụ trách tiến độ, phân công thành viên và điều phối quy trình phê duyệt tài liệu. | Toàn quyền quản lý dự án, gán quyền thành viên, chuyển trạng thái tài liệu, phê duyệt đóng băng Baseline. | |
| QA / Technical Reviewer | Chuyên viên thẩm định chất lượng và chuyên gia kỹ thuật rà soát tính khả thi và đầy đủ của đặc tả. | Xem toàn văn tài liệu, tạo nhận xét trên từng thành phần, đánh dấu giải quyết góp ý, tham gia nghiệm thu. | |
| System Administrator | Quản trị viên hệ thống phụ trách quản lý tài khoản người dùng, vai trò và giám sát nhật ký audit log. | Quản trị hệ thống, cấp phát tài khoản, phân quyền vai trò AppRole, giám sát AuditLog và sao lưu dữ liệu. | |
| Hệ thống Quản lý Dự án Jira | Hệ thống bên ngoài theo dõi task và ticket quản trị vòng đời phát triển. | Tra cứu liên kết task thông qua Jira URL tích hợp sẵn trên từng tài liệu SRS. |
| Mục | Tên giao diện | Mô tả | Giao thức | Thao tác |
|---|---|---|---|---|
| 3.1 | Giao diện Người dùng Web (Responsive Web UI) | Giao diện web hiện đại xây dựng bằng Razor Views, Bootstrap 5.3 và biểu tượng Bootstrap Icons, hỗ trợ hiển thị tối ưu trên màn hình độ phân giải từ 1280x720 trở lên. | HTTPS / HTML5 / CSS3 | |
| 3.2 | Giao diện Cơ sở Dữ liệu Microsoft SQL Server | Kết nối lưu trữ dữ liệu thông qua ADO.NET và Entity Framework Core với kết nối bảo mật SSL/TLS mã hóa đường truyền. | TDS (Tabular Data Stream) / Port 1433 | |
| 3.3 | Động cơ Xuất bản Tài liệu Word OpenXML | Dịch vụ máy chủ SrsWordExportService sử dụng thư viện DocumentFormat.OpenXml để sinh file Word định dạng .docx nguyên bản. | OpenXML SDK (ISO/IEC 29500) | |
| 3.4 | Liên kết Trình theo dõi Công việc Atlassian Jira | Tích hợp liên kết Deep-link trực tiếp đến Project / Issue tương ứng trên hệ thống Jira thông qua giao thức web an toàn. | HTTPS / REST Web URL |
4. Nhóm & Yêu cầu Chức năng (FR)
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-DASH-01 | Hệ thống phải hiển thị số lượng dự án đang kích hoạt, tổng số tài liệu SRS phân bổ theo từng trạng thái (Draft, In Review, Approved, Baselined). | Trung bình | Đề xuất | |
| FR-DASH-02 | Hệ thống phải cung cấp danh sách truy cập nhanh các tài liệu vừa cập nhật và nút bấm điều hướng tạo mới tài liệu. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-DOC-01 | Hệ thống phải cho phép tạo mới tài liệu SRS (Create) với mã hiệu doc_code, tên hệ thống tiếng Việt/tiếng Anh, tên đơn vị phát hành (mặc định CÔNG TY TNHH ĐẦU TƯ QF), phiên bản ban đầu 1.0 và trạng thái DRAFT. | Trung bình | Đề xuất | |
| FR-DOC-02 | Hệ thống phải cho phép chỉnh sửa thông tin tài liệu (EditDocument) gồm tiêu đề, tên đơn vị, mục đích, phạm vi tóm tắt, link bản chạy thử (demo_url) và Jira URL. | Trung bình | Đề xuất | |
| FR-DOC-03 | Hệ thống phải hỗ trợ xóa tài liệu (DeleteDocument) theo cơ chế xóa mềm (Soft Delete bằng cờ is_deleted = 1) để bảo đảm an toàn dữ liệu. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-REQ-01 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Nhóm yêu cầu (RequirementGroup) gồm mã nhóm (GroupCode), tên nhóm, mục số chương (SectionNo) và thứ tự hiển thị. | Trung bình | Đề xuất | |
| FR-REQ-02 | Hệ thống phải cho phép Thêm mới Yêu cầu chức năng FR (AddRequirement) với mã định danh (ReqCode), nội dung đặc tả, nhóm yêu cầu, độ ưu tiên, tiêu chí nghiệm thu và phương pháp kiểm chứng. | Trung bình | Đề xuất | |
| FR-REQ-03 | Hệ thống phải cho phép Chỉnh sửa Yêu cầu chức năng (EditRequirement) và hiển thị trực tiếp trong modal biên tập giao diện chi tiết. | Trung bình | Đề xuất | |
| FR-REQ-04 | Hệ thống phải cho phép Xóa Yêu cầu chức năng (DeleteRequirement) kèm xác nhận bảo đảm an toàn. | Trung bình | Đề xuất | |
| FR-REQ-05 | Hệ thống phải hỗ trợ Quản lý Yêu cầu phi chức năng NFR (Thêm, Sửa, Xóa) phân loại theo 10 nhóm tiêu chuẩn ISO 25010 kèm chỉ số đo lường (metric) cụ thể. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-UC-01 | Hệ thống phải cho phép Thêm mới Kịch bản Use Case (AddUseCase) gồm Mã kịch bản (UcCode), Tên Use Case, Mô tả, Tiền điều kiện, Hậu điều kiện và Độ ưu tiên. | Trung bình | Đề xuất | |
| FR-UC-02 | Hệ thống phải cho phép Chỉnh sửa thông tin Use Case (EditUseCase) và Xóa Use Case (DeleteUseCase) kèm cơ chế dọn dẹp các bước luồng liên quan. | Trung bình | Đề xuất | |
| FR-UC-03 | Hệ thống phải cho phép Thêm bước thực hiện kịch bản (AddUseCaseStep) phân định rõ: Luồng chính (MAIN), Luồng rẽ nhánh (ALTERNATE) và Ngoại lệ (EXCEPTION). | Trung bình | Đề xuất | |
| FR-UC-04 | Hệ thống phải cho phép Sửa (EditUseCaseStep) và Xóa (DeleteUseCaseStep) từng bước thực hiện kịch bản Use Case ngay trong bảng danh sách. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-DATA-01 | Hệ thống phải cho phép Thêm Bảng thực thể dữ liệu (AddDataEntity) với Mã bảng (EntityCode), Tên tiếng Việt và Mô tả ý nghĩa nghiệp vụ. | Trung bình | Đề xuất | |
| FR-DATA-02 | Hệ thống phải cho phép Sửa (EditDataEntity) và Xóa Bảng thực thể (DeleteDataEntity) kèm ràng buộc toàn vẹn đối với các thuộc tính trực thuộc. | Trung bình | Đề xuất | |
| FR-DATA-03 | Hệ thống phải cho phép Thêm Thuộc tính dữ liệu (AddDataAttribute) với Tên cột (AttrName), Kiểu dữ liệu SQL, Khóa chính (PK), Khóa ngoại (FK), Cho phép Null, Giá trị mặc định và Ghi chú quy tắc. | Trung bình | Đề xuất | |
| FR-DATA-04 | Hệ thống phải cho phép Sửa (EditDataAttribute) và Xóa (DeleteDataAttribute) thuộc tính dữ liệu của bất kỳ bảng thực thể nào. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-FIG-01 | Hệ thống phải cho phép Đăng tải Sơ đồ & Hình ảnh (UploadFigure) với chú thích caption, mô tả, phân loại sơ đồ (Kiến trúc, Use Case, ERD, Khác) và vị trí mục số chương. | Trung bình | Đề xuất | |
| FR-FIG-02 | Hệ thống phải cho phép Xóa Hình ảnh (DeleteFigure) và tự động dọn dẹp liên kết tệp trong tài liệu. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-OVW-01 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Hạng mục phạm vi (AddScopeItem, EditScopeItem, DeleteScopeItem) phân định rõ phạm vi thực hiện (IN Scope) và phạm vi không thực hiện (OUT Scope). | Trung bình | Đề xuất | |
| FR-OVW-02 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Thuật ngữ viết tắt (AddGlossaryTerm, EditGlossaryTerm, DeleteGlossaryTerm) gồm từ viết tắt, tên đầy đủ và giải thích ngữ nghĩa. | Trung bình | Đề xuất | |
| FR-OVW-03 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Tài liệu tham khảo (AddDocReference, EditDocReference, DeleteDocReference) gồm mã tham chiếu, tên tài liệu và liên kết URL. | Trung bình | Đề xuất | |
| FR-OVW-04 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Tác nhân người dùng (AddActor, EditActor, DeleteActor) phân loại Người dùng (USER) hoặc Hệ thống ngoài (SYSTEM) kèm quyền hạn chính. | Trung bình | Đề xuất | |
| FR-OVW-05 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Ràng buộc & Giả định (AddConstraintAssumption, EditConstraintAssumption, DeleteConstraintAssumption) phân theo CONSTRAINT, ASSUMPTION, DEPENDENCY. | Trung bình | Đề xuất | |
| FR-OVW-06 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Giao diện kết nối ngoại vi (AddExternalInterface, EditExternalInterface, DeleteExternalInterface) gồm giao diện Người dùng (UI), CSDL, Phần mềm, Truyền thông và giao thức sử dụng. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-TRC-01 | Hệ thống phải cung cấp ma trận truy vết 2 chiều ánh xạ giữa Yêu cầu (Requirement) với Nhu cầu kinh doanh (BusinessNeed) và Ca kiểm thử (TestCase). | Trung bình | Đề xuất | |
| FR-TRC-02 | Hệ thống phải hỗ trợ Thêm, Sửa, Xóa Vấn đề tồn đọng (AddOpenIssue, EditOpenIssue, DeleteOpenIssue) theo mã TBD-xx, người chịu trách nhiệm, hạn hoàn thành và trạng thái xử lý. | Trung bình | Đề xuất |
| Mã YC | Nội dung yêu cầu | Độ ưu tiên | Trạng thái | Thao tác |
|---|---|---|---|---|
| FR-REV-01 | Hệ thống phải cho phép Thêm ý kiến Thẩm định & Nhận xét (AddComment) theo từng thành phần tài liệu (component_type: DOCUMENT, REQUIREMENT, USECASE, DATA_ENTITY, FIGURE) kèm component_id và tên thành phần tương ứng. | Trung bình | Đề xuất | |
| FR-REV-02 | Hệ thống phải cho phép Giải quyết nhận xét (ResolveComment), Mở lại nhận xét (ReopenComment) và Xóa nhận xét (DeleteComment) với đầy đủ người giải quyết, thời gian và ghi chú giải trình resolution_note. | Trung bình | Đề xuất | |
| FR-PUB-01 | Hệ thống phải cung cấp chế độ Xem trước Trực quan Toàn văn 5 Chương (Preview Mode) và Xuất bản file Word (.docx) chuẩn BM01.QT.QF thông qua OpenXML kèm trang bìa CÔNG TY TNHH ĐẦU TƯ QF và link chạy thử. | Trung bình | Đề xuất | |
| FR-PUB-02 | Hệ thống phải hỗ trợ Đóng băng Phiên bản Baseline (Baseline) chuyển trạng thái tài liệu sang BASELINED (chỉ cho phép khi toàn bộ nhận xét đã được RESOLVE). | Trung bình | Đề xuất |
5. Yêu cầu Phi chức năng (NFR)
| Mã NFR | Phân loại | Mô tả yêu cầu | Chỉ số đo lường (Metric) | Thao tác |
|---|---|---|---|---|
| NFR-PERF-01 | Chung | Hệ thống phải đáp ứng thời gian phản hồi cho các thao tác đọc/ghi dữ liệu dưới 1.5 giây với 100 người dùng đồng thời. | Response time <= 1500ms (95th percentile) |
|
| NFR-SEC-01 | Chung | Mật khẩu người dùng phải được mã hóa một chiều bằng thuật toán PBKDF2; hệ thống kiểm soát phân quyền dựa trên vai trò (RBAC) nghiêm ngặt. | PBKDF2 10,000+ iterations |
|
| NFR-AVAIL-01 | Chung | Hệ thống phải duy trì chỉ số sẵn sàng dịch vụ tối thiểu 99.5% trong giờ làm việc hành chính từ thứ Hai đến thứ Bảy. | Uptime >= 99.5% |
|
| NFR-COMP-01 | Chung | Hệ thống phải hiển thị hoàn hảo trên các trình duyệt hiện đại (Google Chrome, Microsoft Edge, Mozilla Firefox) và hỗ trợ bảng mã tiếng Việt Unicode UTF-8 toàn diện. | 100% hiển thị đúng font tiếng Việt |
|
| NFR-MAINT-01 | Chung | Mã nguồn hệ thống phải tuân thủ kiến trúc phân tầng (Clean Architecture), sử dụng Entity Framework Core Code-First/Db-First có tài liệu kỹ thuật đầy đủ để dễ dàng mở rộng. | Mức độ bao phủ kiểm thử > 70% |
|
| NFR-BACKUP-01 | Chung | Cơ sở dữ liệu phải được thiết lập chế độ sao lưu định kỳ (Daily Full Backup và Hourly Transaction Log Backup) lưu trữ an toàn. | RPO <= 1 giờ, RTO <= 2 giờ |
4.8 Đặc tả Use Case
Tiền điều kiện: Người dùng đã đăng nhập hệ thống và có vai trò ADMIN, MANAGER hoặc ANALYST.
Hậu điều kiện: Tài liệu được tạo ở trạng thái DRAFT, phiên bản 1.0 được ghi nhận trong lịch sử phiên bản.
Các bước kịch bản:
Tiền điều kiện: Người dùng có vai trò quản lý tài liệu tương ứng.
Hậu điều kiện: Thông tin tài liệu được cập nhật hoặc chuyển trạng thái is_deleted = 1 an toàn.
Các bước kịch bản:
Tiền điều kiện: Tài liệu đang mở ở chế độ soạn thảo (DRAFT hoặc IN_REVIEW).
Hậu điều kiện: Cây yêu cầu được cập nhật đồng bộ, sẵn sàng cho việc lập ma trận truy vết.
Các bước kịch bản:
-
1 Người dùng truy cập màn hình Chi tiết tài liệu và chọn tab "4. Yêu cầu Chức năng (FR)" hoặc "5. Yêu cầu Phi chức năng (NFR)".
-
2 Hệ thống hiển thị danh sách các nhóm yêu cầu hiện có kèm bảng danh sách các yêu cầu trực thuộc.
-
3 Người dùng bấm nút "Thêm Yêu cầu FR mới", hệ thống hiển thị Modal thêm yêu cầu với các trường thông tin chuẩn hóa.
-
4 Người dùng nhập Mã yêu cầu (ReqCode), nội dung yêu cầu, chọn Nhóm yêu cầu, Độ ưu tiên, Tiêu chí nghiệm thu và Phương pháp kiểm thử.
-
5 Người dùng bấm nút "Lưu Yêu cầu", hệ thống kiểm tra tính duy nhất của ReqCode và lưu vào cơ sở dữ liệu.
-
6 Hệ thống thông báo thành công và cập nhật tức thì dòng yêu cầu mới trên bảng danh sách.
-
3a Chỉnh sửa yêu cầu: Người dùng bấm biểu tượng Sửa (Cây bút) trên dòng yêu cầu tương ứng, sửa đổi thông tin trong Modal và nhấn Lưu.
-
3b Xóa yêu cầu: Người dùng bấm biểu tượng Thùng rác, hệ thống hiển thị hộp thoại xác nhận; khi người dùng đồng ý, hệ thống cập nhật cờ is_deleted = 1.
-
5a Nếu Mã yêu cầu đã tồn tại trong tài liệu: Hệ thống hiển thị thông báo lỗi trùng mã và yêu cầu người dùng nhập mã khác.
Tiền điều kiện: Use Case đã được khai báo trong danh mục tài liệu.
Hậu điều kiện: Kịch bản luồng sự kiện được lưu trữ chi tiết, hỗ trợ lập trình và kiểm thử chính xác.
Các bước kịch bản:
-
1 Người dùng mở tab "4.8 Use Case" trên màn hình Chi tiết tài liệu.
-
2 Người dùng bấm nút "Thêm Use Case", nhập Mã Use Case (UcCode), Tên Use Case, Mô tả, Tiền điều kiện, Hậu điều kiện và bấm Lưu.
-
3 Hệ thống tạo bản ghi UseCase và hiển thị khung biên tập chi tiết kịch bản các bước.
-
4 Người dùng bấm "Thêm bước", chọn Loại luồng (MAIN / ALTERNATE / EXCEPTION), nhập nhãn bước (ví dụ: 1, 2, 3a) và nội dung hành động tương tác.
-
5 Hệ thống lưu trữ từng bước kịch bản vào bảng srs.UseCaseStep và hiển thị dạng danh sách có đánh số thứ tự trực quan.
-
4a Sửa hoặc Xóa bước: Người dùng có thể nhấn nút Sửa/Xóa ngay tại từng dòng của bước kịch bản để hiệu chỉnh nhanh.
Tiền điều kiện: Tài liệu đang ở chế độ chỉnh sửa.
Hậu điều kiện: Từ điển dữ liệu được cập nhật, phục vụ tự động hóa render bảng thuộc tính trong tài liệu Word.
Các bước kịch bản:
-
1 Người dùng truy cập tab "6. Từ điển Dữ liệu" trên màn hình Chi tiết tài liệu.
-
2 Người dùng bấm "Thêm Bảng thực thể mới", nhập Mã bảng (EntityCode, ví dụ: srs.ReviewComment), Tên tiếng Việt và Mô tả ý nghĩa.
-
3 Hệ thống khởi tạo bản ghi DataEntity và mở khung danh sách thuộc tính của bảng đó.
-
4 Người dùng bấm "Thêm Thuộc tính", nhập Tên cột (AttrName), Kiểu dữ liệu SQL (nvarchar, int, datetime2...), chọn cờ Khóa chính (PK), Khóa ngoại (FK), Cho phép Null và Giá trị mặc định.
-
5 Hệ thống lưu trữ thuộc tính vào bảng srs.DataAttribute và tự động gắn Badge PK màu vàng, FK màu xanh trên bảng trực quan.
-
4a Sửa hoặc Xóa thuộc tính: Người dùng bấm nút sửa/xóa tại dòng tương ứng trên bảng từ điển dữ liệu để cập nhật thông số.
Tiền điều kiện: Tệp hình ảnh có định dạng hợp lệ (PNG, JPG, SVG) dung lượng <= 10MB.
Hậu điều kiện: Hình ảnh được lưu an toàn trên máy chủ và sẵn sàng nhúng vào tài liệu Word xuất bản.
Các bước kịch bản:
Tiền điều kiện: Tài liệu đang ở chế độ chỉnh sửa.
Hậu điều kiện: Thông tin tổng quan của tài liệu được hoàn thiện đầy đủ theo chuẩn BM01.
Các bước kịch bản:
Tiền điều kiện: Các yêu cầu chức năng đã được khởi tạo trong hệ thống.
Hậu điều kiện: Ma trận truy vết bảo đảm độ bao phủ 100%, kiểm soát các rủi ro phát triển phần mềm.
Các bước kịch bản:
Tiền điều kiện: Người dùng có vai trò REVIEWER hoặc AUTHOR.
Hậu điều kiện: Ý kiến thẩm định được theo dõi chặt chẽ; 100% nhận xét phải được Resolve trước khi nghiệm thu.
Các bước kịch bản:
-
1 Reviewer truy cập màn hình Xem trước (Preview) hoặc Chi tiết tài liệu (Document Details).
-
2 Reviewer chọn thành phần cần góp ý (Ví dụ: Yêu cầu FR-DOC-02, Use Case UC-04, Bảng srs.ReviewComment hoặc Toàn bộ tài liệu).
-
3 Reviewer bấm nút "Thêm Nhận xét", hệ thống tự động điền loại thành phần (component_type) và mã định danh (component_id) tương ứng.
-
4 Reviewer nhập nội dung nhận xét chi tiết, đề xuất chỉnh sửa và bấm "Gửi Nhận xét".
-
5 Hệ thống lưu trữ bản ghi vào bảng srs.ReviewComment với trạng thái OPEN và cập nhật tức thì badge số nhận xét tại vị trí thành phần.
-
6 Tác giả (BA) xem danh sách nhận xét trên tab Truy vết & Thẩm định, tiến hành hiệu chỉnh tài liệu và gửi phản hồi giải trình.
-
7 Reviewer kiểm tra lại nội dung đã sửa và bấm "Đánh dấu Đã giải quyết (Resolve)", hoàn tất vòng đời góp ý.
-
7a Mở lại nhận xét (Reopen): Nếu nội dung hiệu chỉnh chưa đạt yêu cầu, Reviewer có thể bấm "Mở lại (Reopen)" kèm giải thích bổ sung.
Tiền điều kiện: Tài liệu đã được hoàn thiện nội dung và không còn nhận xét thẩm định nào ở trạng thái OPEN.
Hậu điều kiện: Tệp Word chuẩn BM01.QT.QF được tạo lập và chuyển giao cho các bên liên quan.
Các bước kịch bản:
-
1 Người dùng chọn tài liệu và bấm nút "Xem trước & Xuất bản" trên thanh tác vụ điều hướng.
-
2 Hệ thống tổng hợp dữ liệu 5 chương và hiển thị giao diện xem trước trực quan với bố cục văn bản hoàn chỉnh.
-
3 Người dùng rà soát thông tin trang bìa CÔNG TY TNHH ĐẦU TƯ QF, bảng kiểm soát phiên bản, các sơ đồ hình ảnh và từ điển dữ liệu.
-
4 Người dùng bấm nút "Tải tài liệu Word (.docx)".
-
5 Dịch vụ SrsWordExportService trên máy chủ tự động sinh tệp Word nguyên bản chuẩn BM01 thông qua OpenXML và truyền tệp về trình duyệt.
-
3a Đóng băng phiên bản Baseline: Nếu tài liệu đã được nghiệm thu và không còn nhận xét OPEN, người dùng có vai trò MANAGER/APPROVER có thể bấm nút "Đóng băng Phiên bản (Baseline)".
-
3b Nếu còn nhận xét ở trạng thái OPEN: Hệ thống hiển thị cảnh báo yêu cầu xử lý triệt để toàn bộ góp ý trước khi cho phép đóng băng.
6. Thực thể & Từ điển Dữ liệu
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|---|---|---|---|---|
document_id |
int (IDENTITY) | ✓ | PK | Khóa chính tự tăng định danh tài liệu | |
project_id |
int | ✓ | - | Khóa ngoại tham chiếu đến srs.Project(project_id) | |
doc_code |
nvarchar(50) | ✓ | - | Mã hiệu tài liệu chuẩn mực (Ví dụ: BM01.QT.QF_SRS_SRSMANAGER) | |
title_vi |
nvarchar(300) | ✓ | - | Tiêu đề tiếng Việt của tài liệu đặc tả | |
system_name_vi |
nvarchar(300) | ✓ | - | Tên hệ thống tiếng Việt đầy đủ | |
current_version_no |
nvarchar(20) | ✓ | - | Số hiệu phiên bản hiện tại (v1.0) | |
status_id |
tinyint | ✓ | - | Trạng thái tài liệu (1: Draft, 2: Review, 3: Approved, 4: Baselined) | |
org_name |
nvarchar(200) | - | - | Tên cơ quan / doanh nghiệp phát hành tài liệu | |
demo_url |
nvarchar(500) | - | - | Đường dẫn trực tiếp bản chạy thử của hệ thống | |
jira_url |
nvarchar(500) | - | - | Đường dẫn dự án trên hệ thống Jira |
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|
| Trường | Kiểu dữ liệu | Bắt buộc | Khóa (PK) | Ghi chú | Thao tác |
|---|---|---|---|---|---|
comment_id |
int (IDENTITY) | ✓ | PK | Khóa chính tự tăng định danh nhận xét thẩm định | |
document_id |
int | ✓ | - | Khóa ngoại liên kết tài liệu srs.SrsDocument | |
component_type |
nvarchar(50) | - | - | Loại thành phần nhận xét: DOCUMENT, REQUIREMENT, USECASE, DATA_ENTITY, FIGURE | |
component_id |
int | - | - | Khóa ngoại mềm trỏ tới ID của thành phần tương ứng | |
component_name |
nvarchar(250) | - | - | Tên hiển thị gợi nhớ của thành phần được góp ý | |
comment_text |
nvarchar(max) | ✓ | - | Nội dung ý kiến nhận xét của người thẩm định | |
status |
nvarchar(10) | ✓ | - | Trạng thái xử lý góp ý: OPEN, RESOLVED, REJECTED | |
commented_by |
int | ✓ | - | ID người dùng gửi nhận xét (AppUser) | |
commented_at |
datetime2 | ✓ | - | Thời điểm tạo nhận xét thẩm định | |
resolved_by |
int | - | - | ID người dùng xác nhận đóng nhận xét | |
resolved_at |
datetime2 | - | - | Thời điểm đóng nhận xét thẩm định | |
resolution_note |
nvarchar(1000) | - | - | Ghi chú giải trình phương án xử lý nhận xét của tác giả |
Hình ảnh & Sơ đồ tài liệu SRS
Chèn sơ đồ Use Case, ERD, Kiến trúc và giao diện màn hình UI (Tệp lưu ở thư mục local wwwroot/uploads/figures/, không lưu binary vào CSDL)
Sơ đồ Kiến trúc Tổng thể Hệ thống SRS Manager (3-Tier Architecture)
Kiến trúc phân tầng Presentation (Razor Views), Application (ASP.NET Core 8, OpenXML, Review Engine) và Data Persistence (EF Core 8 + SQL Server).
arch_diagram.png
Sơ đồ Use Case Tổng quan Phân quyền Người dùng
Toàn cảnh tương tác giữa 4 Tác nhân (Admin, PM, BA, QA Reviewer) với các phân hệ chức năng.
usecase_diagram.png
Quy trình Vòng đời Tài liệu SRS và Đóng băng Phiên bản (Baseline Lifecycle)
Luồng chuyển trạng thái Draft -> In Review -> Approved -> Baselined và quy trình Change Request.
workflow_publishing.png
Quy trình Thẩm định Nhận xét theo Từng thành phần Tài liệu (Component Review)
Luồng nghiệp vụ gửi nhận xét, phản hồi, gán component_type & component_id và đóng nhận xét (Resolve).
workflow_review.png
Sơ đồ Mô hình Quan hệ Thực thể Toàn diện (Full ERD Diagram - 19 Entities)
Mô hình cơ sở dữ liệu chi tiết của hệ thống với 19 bảng và quan hệ khóa ngoại toàn vẹn.
erd_diagram.png
Giao diện Bảng điều khiển Tổng quan (Dashboard)
Màn hình thống kê số lượng dự án, tài liệu, trạng thái phát hành và tiến độ thẩm định.
screen_dashboard.png
Giao diện Danh sách Tài liệu Đặc tả Yêu cầu (Document Index)
Danh mục quản lý tài liệu, tìm kiếm, lọc và gắn nhãn bản quyền CÔNG TY TNHH ĐẦU TƯ QF.
screen_document_list.png
Giao diện Khởi tạo Tài liệu Đặc tả Yêu cầu Mới (Create Document)
Màn hình nhập thông tin định danh, tên đơn vị phát hành mặc định CÔNG TY TNHH ĐẦU TƯ QF và link bản chạy thử.
screen_create_document.png
Giao diện Tab 1: Tổng quan & Phạm vi Tài liệu (Overview & Scope Tab)
Màn hình quản lý Mục đích, Tóm tắt phạm vi, Phạm vi chi tiết In/Out Scope, Thuật ngữ viết tắt và Tài liệu tham khảo.
screen_tab_overview.png
Giao diện Tab 2 & 3: Tác nhân & Giao diện bên ngoài (Actors & Interfaces Tab)
Màn hình quản lý danh sách Tác nhân Actor, Ràng buộc / Giả định kỹ thuật và Giao diện kết nối ngoài.
screen_tab_interface.png
Giao diện Tab 4: Quản lý Nhóm & Yêu cầu Chức năng FR (Functional Requirements Tab)
Màn hình quản lý phân nhóm RequirementGroup và các thao tác Thêm, Sửa, Xóa yêu cầu FR chi tiết.
screen_tab_fr.png
Giao diện Tab 5: Quản lý Yêu cầu Phi chức năng NFR (Non-Functional Requirements Tab)
Màn hình đặc tả chỉ tiêu chất lượng NFR theo 10 phân loại tiêu chuẩn ISO 25010 kèm metric đo lường.
screen_tab_nfr.png
Giao diện Tab 4.8: Quản lý Đặc tả Use Case & Luồng sự kiện (Use Cases Tab)
Màn hình quản lý Use Case, liên kết Actor và biên soạn từng bước luồng chính, luồng nhánh và ngoại lệ.
screen_tab_uc.png
Giao diện Tab 6: Từ điển Dữ liệu & Thiết kế Thực thể ERD (Data Dictionary Tab)
Màn hình quản lý Bảng dữ liệu DataEntity, Thuộc tính DataAttribute, Khóa chính PK, Khóa ngoại FK và Quan hệ.
screen_tab_data.png
Giao diện Tab 7: Ma trận Truy vết & Trung tâm Nhận xét Thẩm định (Traceability & Review Tab)
Màn hình liên kết Business Need, Test Case và quản lý danh sách ý kiến thẩm định theo từng thành phần.
screen_tab_trace.png
Giao diện Quản lý Sơ đồ, Hình ảnh & Media đính kèm (Figures Tab)
Màn hình upload hình ảnh, gán vị trí chương mục, phân loại sơ đồ và xem trước media.
screen_tab_figures.png
Giao diện Xem trước Toàn diện 5 Chương & Xuất bản Word BM01 (Preview & Publish)
Giao diện xem trước trực quan tài liệu theo định dạng văn bản chuẩn và nút xuất bản OpenXML .docx.
screen_preview_publish.png
Giao diện Đăng nhập Hệ thống Bảo mật (Authentication Login)
Màn hình xác thực đăng nhập người dùng mã hóa an toàn PBKDF2.
screen_login.png
| Mã YC | Nhu cầu nghiệp vụ | Test Case | Kết quả |
|---|---|---|---|
| NFR-PERF-01 | |||
| NFR-SEC-01 | |||
| NFR-AVAIL-01 | |||
| NFR-COMP-01 | |||
| NFR-MAINT-01 | |||
| NFR-BACKUP-01 |
| Mã | Mô tả | Trạng thái | Thao tác |
|---|
Kiểm tra lại xem trường component_type và component_id đã có chỉ mục hỗ trợ truy vấn tối ưu chưa.
Xác nhận tính năng nhận xét theo thành phần hoạt động rất tốt, đã hỗ trợ phân loại component_type chính xác.
Đề nghị bổ sung bước phân nhánh alternate flow cho trường hợp chỉnh sửa hoặc xóa nhanh bước luồng sự kiện.
Đề xuất bổ sung kiểm tra định dạng URL hợp lệ trước khi lưu link bản chạy thử demo_url.
Đề nghị kiểm tra và đồng bộ tên đơn vị phát hành thành CÔNG TY TNHH ĐẦU TƯ QF trên toàn bộ trang bìa và chân trang.
Kiểm tra lại xem trường component_type và component_id đã có chỉ mục hỗ trợ truy vấn tối ưu chưa.