Hướng dẫn viết URD
|
Tài liệu đặc tả yêu cầu người dùng : Tài liệu đặc tả yêu cầu người dùng NỘI DUNG SỬA ĐỔI *M- Mới S Sửa X - Xóa Ngà Views 290 Downloads 25 File size 345KB Report DMCA / Copyright DOWNLOAD FILE Recommend StoriesCitation previewTài liệu đặc tả yêu cầu người dùng : Tài liệu đặc tả yêu cầu người dùng NỘI DUNG SỬA ĐỔI *M- Mới S Sửa X - Xóa Ngày Mục sửa đổi 30/05/2011 Tạo mới 28/06/2011 Format tài liệu 41-BM/SO/CSOFT Tài liệu nội bộ 2/18/ : Tài liệu đặc tả yêu cầu người dùng TRANG KÝ CTIN NGƯỜI LẬP: NGƯỜI KIỂM TRA: NGƯỜI PHÊ DUYỆT: NGƯỜI KIỂM TRA: NGƯỜI PHÊ DUYỆT: 41-BM/SO/CSOFT Tài liệu nội bộ 3/18/ : Tài liệu đặc tả yêu cầu người dùng MỤC LỤC 1. GIỚI THIỆU.......................................................................................................................................................... 1.1. Mục tiêu tài liệu............................................................... 1.2. Phạm vi tài liệu................................................................. 1.3. Thuật ngữ và các từ viết tắt.............................................. 1.4. Tài liệu tham khảo ........................................................... 1.5. Cấu trúc Tài liệu .............................................................. 2. TỔNG QUAN VỀ HỆ THỐNG .......................................................................................................................... 3. 2.1. Phát biểu bài toán ............................................................ 2.2. Mục tiêu hệ thống ............................................................ 2.3. Phạm vi hệ thống ............................................................. QUY TRÌNH NGHIỆP VỤ ................................................................................................................................. 3.1. Quy trình 1 ...................................................................... 3.2. Quy trình .................................................................. 4. YÊU CẦU CHỨC NĂNG CỦA NGƯỜI SỬ DỤNG..................................................................................... 4.1. Phân hệ / Module ..................................................... 5. CÁC YÊU CẦU PHI CHỨC NĂNG................................................................................................................ 6. 5.1. : Yêu cầu bảo mật ............................. 5.2. : Yêu cầu sao lưu .............................. 5.3. : Yêu cầu về tính sử dụng (Usability) 5.4. : Yêu cầu về tính ổn định (Reliability 5.5. : Yêu cầu về kích thước hệ thống (Si 5.6. : Yêu cầu về hiệu năng (Performance 5.7. : Yêu cầu về tính hỗ trợ (Supportabil 5.8. : Các ràng buộc thiết kế (Design Con 5.9. : Yêu cầu về giao tiếp hệ thống......... 5.10. : Các yêu cầu tài liệu người dùng và 5.11. : Các yêu cầu pháp lý, bản quyền và 5.12. : Các tiêu chuẩn áp dụng .................. 5.13. : Các yêu cầu khác ........................... TIÊU CHUẨN NGHIỆM THU HỆ THỐNG ................................................................................................. 41-BM/SO/CSOFT Tài liệu nội bộ 4/18/ : Tài liệu đặc tả yêu cầu người dùng Ghi chú: Các đoạn text nằm trong dấu ngoặc đơn vuông [] và được trình bày bằng màu chữ xanh Hyperlink là những mô tả chi tiết, hướng dẫn và có thể là những gợi ý cho các đề mục tương ứng. Các đoạn text nằm trong dấu ngoặc nhọn và được trình bày bằng màu chữ nâu là những ví dụ minh họa. Các đoạn text này cần được bỏ khi người viết thực hiện viết các tài liệu trên template này. 41-BM/SO/CSOFT Tài liệu nội bộ 5/18/ : Tài liệu đặc tả yêu cầu người dùng 1. GIỚI THIỆU 1.1. Mục tiêu tài liệu [Phần này trình bày các Nội dung sau đây: Xác định mục tiêu của tài liệu Xác định đối tượng sẽ sử dụng tài liệu hoặc tài liệu làm đầu vào cho giai đoạn / quá trình kế tiếp, xây dựng dựa trên các thông tin nào...] 1.2. Phạm vi tài liệu [Phần này trình bày về: Xác định các tên sản phẩm phần mềm được xây dựng 1 Giải thích về phạm vi các sản phẩm phần mềm đề xuất sẽ đáp ứng (và sẽ không đáp ứng, nếu cần thiết) cùng lợi ích, kết quả và mục tiêu đạt được một cách chính xác nhất có thể. 1.3. Thuật ngữ và các từ viết tắt [Phần này sẽ liệt kê định nghĩa của các khái niệm, thuật ngữ ] Thuật ngữ Bảng 1: Thuật ngữ và định nghĩa 1.4. Tài liệu tham khảo [Phần này cung cấp danh sách đầy đủ các tài liệu tham khảo liên quan. Mỗi tài liệu được xác định bằng tên tài liệu, tác giả và ngày phát hành đồng thời cũng phải chỉ rõ là tài liệu này có thể dùng được hay chỉ mang tính chất tham khảo. Nếu thích hợp cần chỉ rõ số hiệu báo cáo, tên tạp chí và tổ chức phát hành ra tài liệu.] Tên tài liệu Bảng 2: Tài liệu tham khảo 1.5. 1 Cấu trúc tài liệu Liệt kê các gói sản phẩm trong dự án 41-BM/SO/CSOFT Tài liệu nội bộ 6/18/ : Tài liệu đặc tả yêu cầu người dùng [Phần này sẽ mô tả tổ chức của tài liệu, Tài liệu bao gồm bao nhiêu phần Nội dung chính, Tên gọi các phần Nội dung chính này.......] [Ví dụ: Tài liệu bao gồm các phần chính: ] 1. Giới thiệu chung 2. Tổng quan Hệ thống 3. Quy trình nghiệp vụ 4. Yêu cầu Chức năng Người sử dụng 5. Các yêu cầu Phi chức năng 6. Tiêu chuẩn nghiệm thu 41-BM/SO/CSOFT Tài liệu nội bộ 7/18/ : Tài liệu đặc tả yêu cầu người dùng 2. TỔNG QUAN THỐNG 2.1. Phát biểu bài toán VỀ HỆ [Phần này mô tả thật ngắn gọn các thông tin như: định nghĩa Hệ thống sẽ xây dựng, đáp ứng mong muốn gì của khách hàng, mang lại lợi ích ra sao cho đối tượng nào?!?] 2.2. Mục tiêu hệ thống [Phần này đưa ra các mục tiêu cần đạt được khi xây dựng hệ thống] 2.3. Phạm vi hệ thống [Phần này đưa thông tin các đơn vị sẽ sử dụng hệ thống, phạm vi sẽ triển khai] 2.3.1. Danh sách người sử dụng hệ thống [Ví dụ: Danh sách nhóm người sử dụng hệ thống STT h m người s 1 Nhân viên 2 Cán bộ Quản lý 3 Lãnh đạo Tổng Công ty các các Công ty Chi Nhánh 4 Quản trị hệ thống h m người s ] ....... o....... 2.3.2. Mô hình tổng thể hệ thống 41-BM/SO/CSOFT Tài liệu nội bộ 8/18/ : Tài liệu đặc tả yêu cầu người dùng 3. QUY TRÌNH NGHIỆP VỤ 3.1. Quy trình 1 3.1.1. Sự kiện kích hoạt quy trình ....... o....... 3.1.2. Mô hình quy trình nghiệp vụ 3.1.3. Mô tả các bước trong quy trình ....... ....... o 3.2. Quy trình 3.2.1. Sự kiện kích hoạt quy trình ....... o....... 3.2.2. Mô hình quy trình nghiệp vụ 3.2.3. Mô tả các bước trong quy trình ....... o....... 41-BM/SO/CSOFT Tài liệu nội bộ 9/18/ : Tài liệu đặc tả yêu cầu người dùng 4. YÊU CẦU CHỨC NĂNG CỦA NGƯỜI SỬ DỤNG 4.1. Ph n hệ / Module [Phần này mô tả các yêu cầu về chức năng của hệ thống. Các yêu cầu này được phát biểu bằng ngôn ngữ tự nhiên. Với nhiều ứng dụng, phần này có thể tạo thành phần quan trọng của tài liệu đặc tả phần mềm. Phần này thường được tổ chức theo điểm đặc trưng, nhưng có thể tổ chức theo cách khác cho thích hợp như tổ chức theo người sử dụng hoặc tổ chức theo hệ thống con. Các yêu cầu chức năng có thể gồm tập hợp các đặc điểm, khả năng và bảo mật.] 4.1.1. Mô tả Yêu cầu: [Mục này mô tả chi tiết các phát biểu của khách hàng (nếu có) hoặc các thu thập của các thành viên đội khảo sát đối với các yêu cầu của Hệ thống; phần này liệt kê đầy đủ các thông tin cần thiết để có thể làm đầu vào cho Tài liệu đặc tả kế tiếp; đồng thời ghi nhận đối tượng nào sử dụng yêu cầu này Mã hiệu yêu cầu đặt theo quy tắc sau: UREQ + 00X (X: tăng dần theo thứ tự trong toàn bộ tài liệu). Ví dụ: oYCCN010101: Quản lý văn bản pháp quy: o Cho ph p quản lý các VBPQ theo các loại; cập nhật mới, hủy bỏ, các VBPQ Sau khi các VBPQ này được cập nhật, thông tin sẽ được ghi nhận vào hệ thống Nhân viên Hành chính của QH sẽ sử dụng yêu cầu này YCCN010102: Quản lý hệ thống các chế định Quản lý hệ thống các chế định có trong hệ thống; cho ph p tạo mới, cập nhật, hủy bỏ các chế định, Sau khi các Chế định này được cập nhật, thông tin sẽ được ghi nhận vào hệ thống Nhân viên Hành chính của QH sẽ sử dụng yêu cầu này ] o....... Các ràng buộc: (nếu có) [Mục này liệt kê các ràng buộc có thể có đối với yêu cầu hiện hành, các ràng buộc này cần được ghi nhận chính xác để làm đầu vào cho các quá trình kế tiếp 41-BM/SO/CSOFT Tài liệu nội bộ 10/18/ : Tài liệu đặc tả yêu cầu người dùng Có thể điền N/A hoặc không ghi nhận nếu không tồn tại các ràng buộc này] o ....... 4.1.2. Mô tả Yêu cầu: [Mục này mô tả chi tiết các phát biểu của khách hàng (nếu có) hoặc các thu thập của các thành viên đội khảo sát đối với các yêu cầu của Hệ thống; phần này liệt kê đầy đủ các thông tin cần thiết để có thể làm đầu vào cho Tài liệu đặc tả kế tiếp] o ....... Các ràng buộc: (nếu có) [Mục này liệt kê các ràng buộc có thể có đối với yêu cầu hiện hành, các ràng buộc này cần được ghi nhận chính xác để làm đầu vào cho các quá trình kế tiếp Có thể điền N/A hoặc không ghi nhận nếu không tồn tại các ràng buộc này] o ....... 41-BM/SO/CSOFT Tài liệu nội bộ 11/18/ : Tài liệu đặc tả yêu cầu người dùng 5. CÁC YÊU CẦU CHỨC NĂNG 5.1. : Yêu cầu bảo mật PHI [Phần này mô tả tất cả các yêu cầu liên quan đến bảo mật dữ liệu. Các yêu cầu này có thể phát biểu độc lập ở đây hoặc trong phần phát biểu yêu cầu chức năng hoặc cả hai Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] ....... o 5.2. ....... : Yêu cầu sao lưu [Phần này mô tả tất cả các yêu cầu liên quan đến sao lưu khôi phục dữ liệu. Các yêu cầu này có thể phát biểu độc lập ở đây hoặc trong phần phát biểu yêu cầu chức năng hoặc cả hai Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Dữ liệu lưu trong hệ thống được sao lưu dự phòng tự động 24/24 bằng một hệ thống song hành tránh mất mát dữ liệu. Dữ liệu hệ thống có thể kết xuất ra các thiết bị lưu trữ ngoài và phục hồi khi cần thiết.] ....... o ....... 5.3. : Yêu cầu về tính s dụng (Usability) [Phần này mô tả tất cả các yêu cầu liên quan đến tính sử dụng (usability). Chẳng hạn: Chỉ ra thời gian đào tạo cần thiết cho người dùng bình thường và người dùng chuyên trách để thao tác hiệu quả hệ thống Chỉ ra số lần tác vụ đo được (measurable task times) cho những tác vụ thông dụng hay thiết lập khả năng sử dụng (usability) của hệ thống mới trên nền các yêu cầu về tính sử dụng của hệ thống cũ hoặc hệ thống mà người dùng đã biết và cảm thấy phù hợp Chỉ ra yêu cầu phù hợp với những khả năng sử dụng chuẩn chung như chuẩn giao diện của Microsoft, Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: 41-BM/SO/CSOFT Tài liệu nội bộ 12/18/ : Tài liệu đặc tả yêu cầu người dùng Hệ thống cho ph p truy cập dữ liệu thời gian thực. Các tác vụ thực hiện tức thời trong thời gian ngừng cho ph p chấp nhận dưới 30s. Hệ thống đảm bảo phục vụ truy cập online 50 người cùng một lúc. Cung cấp một giao diện thân thiện phù hợp với quy trình nghiệp vụ hiện đang vận hành. Hệ thống đơn giản trong cài đặt và quản lý. Hệ thống hỗ trợ các trình duyệt phổ biến là IE, Nescape, Mozilla Firefox.] ....... o 5.4. ....... : Yêu cầu về tính ổn định (Reliability) [Các yêu cầu về tính ổn định của hệ thống mô tả ở đây. Một số đề xuất như: Tính sẵn sàng (Availability Chỉ ra tỷ lệ phần trăm sẵn sàng ( xx.xx%), số giờ sử dụng, bảo hành, chế độ vận hành suy giảm .... Thời gian trung bình giữa hai sự cố (Mean Time Between Failures - MTBF) được tính bằng giờ, tuy nhiên cũng có thể tính bằng ngày, tháng hoặc năm. Thời gian trung bình phải sửa chữa (Mean Time To Repair MTTR)Khi hệ thống bị lỗi, cho phép hệ thống không làm việc bao lâu? Tính chính xác chỉ ra precision (resolution) và accuracy (theo tiêu chuẩn nào đó) đối với đầu ra của hệ thống. Maximum Bugs hay Defect Ratethường biểu diến bằng (bugs/KLOC) hay bugs per function-point ( bugs/function-point). Bugs hay Defect Rate phân loại theo minor, significant, hay critical bugs: Yêu cầu phải chỉ rõ thế nào là critical bug; ví dụ, mất dữ liệu toàn bộ hay mất khả năng sử dụng toàn bộ một phần chức năng nào đó của hệ thống. Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Khi xảy ra các sự cố làm ngừng vận hành hệ thống, hệ thống phải đảm bảo phục hồi 90% trong vòng 1h và 100% trong vòng 24h. Hệ thống gây trung bình 1 lỗi / tháng trong 3 tháng vận hành đầu tiên. 1 lỗi / năm trong 3 năm vận hành tiếp theo và 0 lỗi / năm trong các năm vận hành tiếp theo. Lỗi chấp nhận là lỗi trung bình không gây tổn hại trầm trọng hệ thống và có thể phục hồi 90% hiệu quả.] ....... o 41-BM/SO/CSOFT Tài liệu nội bộ 13/18/ ....... : Tài liệu đặc tả yêu cầu người dùng 5.5. : Yêu cầu về kích thước hệ thống (Sizing) [Yêu cầu về kích thước của hệ thống như: 5.6. Số user của hệ thống Số lượng giao dịch mà hệ thống cần đáp ứng Dung lượng về dữ liệu mà hệ thống cần lưu trữ hoặc xử lý ] : Yêu cầu về hiệu năng (Performance) [Yêu cầu về các đặc trưng hiệu năng của hệ thống được mô tả ở đây. Nó bao gồm thời gian phản hồi đặc trưng. Khi có thể, tham chiếu tới những Use Cases liên quan theo tên. Response time đối với giao dịch (average, maximum) Throughput, ví dụ, số giao dịch trong 1 giây Capacity, ví dụ, số khách hàng hay giao dịch mà hệ thống có thể đáp ứng Degradation modes (Chế độ làm việc có thể chấp nhận được mỗi khi hệ thống bị trục trặc nào đó) Resource utilization, memory, communications,... như disk, Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Các tác vụ thực hiện tức thời trong thời gian ngừng cho ph p chấp nhận dưới 30s. Hệ thống đảm bảo phục vụ truy cập online 50 người cùng một lúc.] ....... ....... o 5.7. : Yêu cầu về tính hỗ trợ (Supportability) [Phần này chỉ ra những yêu cầu về khả năng hỗ trợ, bảo hành hệ thống được xây dựng, bao gồm coding standards, naming conventions, class libraries, maintenance access, và maintenance utilities. Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Hệ thống được hỗ trợ 24/24 trong vòng 1 năm miễn phí sau khi hệ thống vận hành chính thức. Các hỗ trợ được thực hiện, phản hồi trong vòng tối đa 48 tiếng giờ làm việc.] ....... o....... 41-BM/SO/CSOFT Tài liệu nội bộ 14/18/ : Tài liệu đặc tả yêu cầu người dùng 5.8. : Các ràng buộc thiết kế (Design Constraints) [Phần này chỉ ra những ràng buộc về thiết kế đối với hệ thống được xây dựng. Các ràng buộc thiết kế là những quyết định thiết kế (design decisions) mà ta phải tuân thủ. Ví dụ ngôn ngữ lập trình, software process requirements, công cụ phát triển sử dụng, các ràng buộc kiến trúc và thiết kế, các thành tố mua ngoài, class libraries, .... Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Hệ thống được xây dựng trên mã nguồn mở. Sử dụng công nghệ servlet/jsp. Web server được sử dụng là Tomcat Apache. Web browser là IE hoặc Netscape hoặc Mozilla Firefox Hệ quản trị cơ sở dữ liệu là MySQL Công cụ phát triển là JBuilder 7.0, EMS, Rational Rose, Photoshop 7.0, Dreamwaver, Microsoft Sourcesafe 6.0 Phân tích và thiết kế được thực hiện theo chuẩn UML Các công cụ hỗ trợ không tính bản quyền, thư viện hỗ trợ khác phải là mã nguồn mở. Hệ thống được thiết kế theo hướng có khả năng phát triển trong tương lai với việc thêm bớt các module, hoặc tích hợp hệ thống vào một hệ thống khác dễ dàng.] ....... o 5.9. ....... : Yêu cầu về giao tiếp hệ thống 5.9.1. : Giao tiếp phần cứng (Software interfaces) [Mô tả các yêu cầu nếu có đối với các phần cứng mà hệ thống cần kết nối, các chuẩn, giao thức kết nối: Ví dụ: đầu đọc mã vạch, máy in tem] 5.9.2. : Giao tiếp phần mềm (Software interfaces) [Mô tả các yêu về giao tiếp với các phần mềm khác, các chuẩn, giao thức sử dụng để kết nối] 5.10. : Các yêu cầu tài liệu người dùng và hỗ trợ trực tuyến [Mô tả yêu cầu, nếu có, đối với tài liệu người dùng, hỗ trợ hệ thống trực tuyến .... Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: 41-BM/SO/CSOFT Tài liệu nội bộ 15/18/ : Tài liệu đặc tả yêu cầu người dùng Tài liệu người dùng được cung cấp đến tận tay người sử dụng cuối Tổ chức huấn luyện người dùng cuối sử dụng hệ thống Hỗ trợ hệ thống giúp đỡ trực tuyến cho người dùng cuối. Hệ thống giúp đỡ trực tuyến được tích hợp trực tiếp vào hệ thống] ....... o....... 5.11. : Các yêu cầu pháp l , bản quyền và những ghi chú khác [Xác định các yêu cầu về bản quyền hay những yêu cầu hạn chế đối với phần mềm, mô tả những từ bỏ pháp lý cần thiết, quyền bảo hành, bản quyền, phát minh, wordmark, trademark, hay những vấn đề về logo compliance đối với phần mềm Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Sau khi hệ thống vận hành, toàn bộ source code phát triển hệ thống được chuyển giao và thuộc quyền quản lý của sở KHCN] ....... o....... 5.12. : Các tiêu chuẩn áp dụng [Phần này mô tả các tham chiếu tới những tiêu chuẩn áp dụng và những đoạn đặc thù của tiêu chuẩn nào đó mà hệ thống áp dụng. Ví dụ, nó có thể bao gồm các tiêu chuẩn về pháp lý, chất lượng, qui định, các chuẩn công nghiệp về tính khả dụng, interoperability, internationalization, operating system compliance, .... Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] [Ví dụ: Hệ thống đáp ứng các yêu cầu: Quy trình phát triển và xây dựng hệ thống được quản lý theo chuẩn ISO....] ....... o....... 5.13. : Các yêu cầu khác Các yêu cầu sẽ được liệt kê nếu c ; ngược lại điền /A hoặc không ghi nhận nếu không tồn tại yêu cầu loại này] ....... o....... 41-BM/SO/CSOFT Tài liệu nội bộ 16/18/ : Tài liệu đặc tả yêu cầu người dùng 41-BM/SO/CSOFT Tài liệu nội bộ 17/18/ : Tài liệu đặc tả yêu cầu người dùng 6. TIÊU CHUẨN NGHIỆM THU HỆ THỐNG [Ví dụ: Hệ thống được nghiệm thu khi thỏa các điều kiện sau: Hệ thống được thiết kế và vận hành theo như mô tả trong tài liệu này, đồng thời đáp ứng > 90% yêu cầu có độ ưu tiên 1 trong Mục 4 của Tài liệu này Hệ thống được hiệu chỉnh sau khi triển khai thử nghiệm Tổ chức hướng dẫn sử dụng đối với người dùng Người sử dụng thao tác tốt trên hệ thống sau khi qua khóa đào tạo của nhân viên FPT Tất cả tài liệu và source chương trình được bàn giao đầy đủ cho Công ty XYZ] ....... o....... 41-BM/SO/CSOFT Tài liệu nội bộ 18/18/ |
