mẫu biểu, quy trình ,phát triển, phần mềm
Trang 1Bảng theo dõi thay đổi tài liệu
Họ tên
Chữ ký
Trang 2Một số quy định chung:
- Cách ghi Số hiệu tài liệu (là tên cột của một số bảng trong BM.PM.05.01) :
sẽ đợc điền mã số tài liệu cần tham khảo để biết thêm thông tin chi tiết về
đối tợng mô tả Cách điền mã số tuân theo quy định sau:
<Tên biểu mẫu>/xxx xxx : có giá trị từ 001 cho đến 999
<tên biểu mẫu> : là mã số biểu mẫu cần tham chiếu tới
Ví dụ : BM.PM.05.04/001
1 Thiết kế chức năng
1.1 Sơ đồ khối chức năng
Yêu cầu: Khi thiết kế sơ đồ khối chức năng phải bám sát nghiệp vụ bài toán,
sao cho khi đọc sơ đồ khối chức năng và phần giải thích bên dới phải hiểu đợc toàn bộ nghiệp vụ của bài toán
Khái niệm chức năng: là phần công việc, thao tác có thể gọi đợc bằng tên
trong yêu cầu nghiệp vụ đặt ra
Khái niệm sơ đồ khối: Mô tả toàn bộ nội dung công việc bài toán đặt ra bằng
hình khối Sơ đồ khối thể hiện quan hệ giữa các chức năng
Một số ký hiệu quy ớc trong sơ đồ khối:
+ Mỗi chức năng đợc biểu diễn trong hình hộp chữ nhật
+ Mũi tên chỉ thứ tự thực hiện chức năng A trớc sau đó
đến chức năng B hoặc chức năng C
+ Chú thích bên trên hoặc bên trái đờng mũi tên Có thể
viết thẳng chú thích bên trên đờng mũi tên hoặc đánh ký mã
hiệu và chú giải bên dới
1.2 Mô tả chi tiết chức năng
1.2.1 Mô tả
-Có thể sử dụng một vài câu ngắn gọn mô tả tổng thể sơ đồ khối
-Đối với mỗi chức năng phải mô tả chi tiết, ít nhất phải có thông tin về tên chức năng, ý nghĩa, mục đích, nội dung, có thể tuỳ từng chức năng mà có thêm các thông tin khác liên quan
1.2.2 Lựa chọn đờng đi của chức năng
STT Chức năng bắt đầu Chức năng tiếp Sự kiện Mô tả
2 1
A
D
Trang 33 B D …
3 Thiết kế các hàm, thủ tục, th viện, hằng,biến dùng chung
3.1 Danh sách :
Điền toàn bộ tên các hàm, thủ tục, th viện, hằng, biến dùng chung ở mức project
Cách điền nội dung vào các cột của bảng ‘Danh sách các hàm, thủ tục, th viện, hằng, biến ’
Bảng : Danh sách các hàm, thủ tục, th viện, hằng, biến
STT Tên Kiểu Nơi gọi Nơi chứa ý nghĩa/mục
đích Số hiệu tài liệu
<Danh sách các hàm>
<Danh sách các thủ tục>
<Danh sách các th viện>
<Danh sách các hằng>
<Danh sách các biến>
Tên: tênhàm, thủ tục, th viện, hằng, biến dùng chung
Kiểu: nếu là biến hoặc hàm thì phải chỉ ra kiểu của chúng là gì (interger, char, boolean, datetime, )
Nơi gọi: là nơi sử dụng tên này (chẳng hạn form nào, event nào, hàm hoặc thủ tục nào, gọi tới tên này)
Nơi chứa: là nơi lu chứa hàm, thủ tục, hằng, biến chỉ ra Ví dụ thủ tục A đặt tại module1, hàm B đặt ở module2, th viện C đặt tại th mục ,ổ đĩa nào,
Số hiệu tài liệu: là mã số tài liệu cần tham chiếu tới để xem những thông tin chi tiết về hàm, thủ tục, hằng, biến dùng chung (mã số tài liệu này cũng đợc ghi trong biểu mẫu BM.PM.05.03)
3.2 Mô tả chi tiết
Cách điền nội dung vào biểu mẫu BM.PM.05.03 nh sau:
Số hiệu tài liệu: (trùng với số hiệu tài liệu điền ở bảng Danh sách các hàm, thủ tục, th viện, hằng, biến mục 3.1,BM.PM.05.01)
Tên (hàm/thủ tục/th viện/hằng/biến): (có thể điền hoặc không)
Cách gọi: chỉ ra cú pháp lời gọi hàm/thủ tục của th viện cần dùng.Trờng hợp hàm, thủ tục dùng chung trong project tự thiết kế thì nội dung này có thể để trống
Sơ đồ và mô tả chi tiết thuật toán: vẽ sơ đồ thuật toán đồng thời mô tả thuật toán cho rõ ràng hơn bằng lời
Chú ý: Mục 4,5 của BM.PM.05.03 có thể không cần áp dụng đối với các th
viện có sẵn, nếu thấy cần thiết phải mô tả kỹ hơn về các th viện thì điền vào mục 6
4 Các tiện ích cần thiết
5 4.1 Danh sách
Bảng : Danh sách các tiện ích
STT Tên Loại ý nghĩa/mục đích Số hiệu tài
liệu
Trang 44.2 Mô tả cách sử dụng : (điền nội dung vào BM.PM.05.04)
Cách điền nội dung vào biểu mẫu BM.PM.05.04 nh sau:
Số hiệu tài liệu: (trùng với số hiệu tài liệu điền ở bảng Danh sách các tiện ích mục 4.1,BM.PM.05.01)
Tên tiện ích : (có thể điền hoặc không)
Mô tả cách sử dụng: mô tả bằng lời một cách rõ ràng để ngời lập trình hiểu
đợc cách sử dụng các tiện ích này (chẳng hạn, cách cài đặt chúng nh thế nào,
đặt ở ổ đĩa và th mục nào, cách gọi chúng ra sao,vv
5 Thiết kế giao diện
5.1 Yêu cầu chung đối với giao diện
Nếu thấy cần thiết phải có yêu cầu chung đối với giao diện thì đa ra, nếu không thấy cần thiết thì phần này có thể bỏ trống Chẳng hạn có thể nêu ra một
số yêu cầu nh:
- Ngôn ngữ sử dụng
- Chơng trình sử dụng là online hay offline, có thờng trú hay không thờng trú
- Có cần hiện lên task bar không
- Màu sắc sử dụng để thiết kế form (tuỳ tính chất của ứng dụng để thiết kế màu sắc, giao diện Ví dụ, làm chơng trình cho đối tợng học sinh sử dụng màu sắc, trang trí phải vui tơi)
- Có cần tạo sẵn các template cho các form không Ví dụ một số chơng trình thống nhất chung template cho các form danh mục, template cho form nhập dữ liệu…
5.2 Cấu trúc giao diện (hình vẽ)
Trên đây là một ví dụ về cấu trúc giao diện một phần trong chơng trình “station” của dự án 119
+ Mỗi form biểu diễn bằng một ô chữ nhật, bên trong ghi tên form
+ Mũi tên theo chiều hớng gọi từ form này tới form kia Trên đờng mũi tên là ký mã hiệu sẽ đợc giải thích trong phần sau
- Liệt kê các form trong chơng trình
STT Tên form Chức năng của form Chức năng
nghiệp vụ liên quan
Số hiệu tài liệu
1 start Kiểm tra quyền truy
5 4 3
2 1
start
Trang 5báo hỏng, thông qua form này gọi đến các chức năng tra cứu, trợ giúp, tra nợ, đo thử
Nội dung của cột ‘Chức năng nghiệp vụ liên quan’ :là tên các chức năng tơng
ứng đợc nêu trong mục ‘1.Thiêt kế chức năng’ của BM.PM.05.01)
Nội dung của cột ‘Số hiệu tài liệu’ : chính là ‘số hiệu tài liệu’ ghi trong biểu mẫu
BM.PM.05.02 mà ngời lập trình cần tham chiếu tới để xem mô tả chi tiết về
form
- Mô tả đờng đi của form
STT Mã hiệu
đờng đi Formgọi Form đợc gọi Sự kiện Mô tả
1 1 start passchangeDl
g Kích vào nút đổi mật khẩu Khi nhập đúng tên và password ngời
sử dụng nút gọi đến form đổi mật khẩu mới enabled
2 2 start main Kích vào nút bắt
đầu Khi nhập đúng tên và password ngời
sử dụng nút gọi đến form main mới enabled
3
5.3 Mô tả chi tiết form
Phần này bao gồm cả hình vẽ và nội dung mô tả
5.3.1 Vẽ hình
Phần này có thể trình bày sơ lợc hoặc chi tiết tuỳ ngời thiết kế(có thể in ra hoặc
vẽ bằng tay) Ví dụ: form start trong chơng trình 119
5.3.2 Mô tả chi tiết:
Trang 6Nội dung phần mô tả chi tiết đợc điền vào BM.PM.05.02, bao gồm các nội dung sau:
Số hiệu tài liệu: điền vào số hiệu để bảng Danh sách các form có thể tham
chiếu tới
Tên form: trùng với tên đợc liệt kê trong bảng Danh sách các form (có thể
không điền cũng đợc)
Bảng mô tả các đối tợng thuộc form:
Ví dụ cho form start
STT Tên object Loại ý nghĩa/mục đích Thuộc object
1 Label1 Label
2 Label2
3 Label3
4 user text Nhập tên ngời truy
nhập 5
6
7
8 Issuechange
pass command Gọi đến form có chức năng đổi mật khẩu
9
Mô tả chi tiết :
Mô tả các hành động, tình huống xảy ra trong phạm vi form tơng ứng với một giá trị nhập mới vào một đối tợng nào đó hoặc khi chọn đối tợng nào đó
Ví dụ form start:
- Ban đầu hai nút lệnh đổi mật khẩu và nút lệnh gọi đến form main không enabled Nhập đầy đủ tên, password thì hai nút lệnh đổi mật khẩu và nút lệnh gọi đến form main sẽ enabled
- Miêu tả cách sử dụng 2 object ADOconnection truy cập vào CSDL lấy dữ liệu nh thế nào Trong quá trình truy cập gặp lỗi sẽ bắt lỗi nh thế nào
- …
6 Thiết kế các reports
6.1 Danh sách các reports:
Cách điền vào bảng thông qua ví dụ sau:
Bảng : Danh sách reports
STT Tên ý nghĩa/mục đích Công cụ tạo
report Nơi gọireport Số hiệu tàiliệu
1 report1 danh sách truy
nhập internet trong tháng
datareport form1 BM.PM.05
05/001
2 report2 danh sách huỷ
account internet trong tháng
crystal reports form2 BM.PM.05.05/002
6.2 Mô tả chi tiết :
(Điền nội dung vào biểu mẫu BM.PM.05.05)
Trang 7Bảng mô tả chi tiết:
Cách điền nội dung thông qua ví dụ sau
STT Tên
đối
t-ợng
Loại
đối t-ợng
Vị trí đặt đối tợng Định dạng dữliệu ý nghĩa/mụcđích Nguồn dữ liệu
1 label1 label left corner of
header,line 1 theo mẫu ‘dd/mm/yy’ hiển thị datehiện tại
2 txt1 textbo
x cột ‘số máy’ của report dồn dữ liệu về mép phải của
textbox
hiện số máy
điện thoại thuê bao
-DB:min -Table: SM -Field: so_may 3
6 Kế hoạch đánh giá và chạy thử
Cách điền vào bảng thông qua ví dụ sau:
Bảng : Kế hoạch đánh giá và chạy thử phần lập trình
STT Nội dung Ngời thực hiện Thời gian thực
hiện hiện/Số hiệu T.LPhơng thức thực
<Kiểm tra chức năng>
1 Quản lý user
2 Quản lý dữ liệu
hệ thống
<Kiểm tra database>
1 Cấu trúc chung
DB có hợp lý
không
2 Cấu trúc từng
bảng
3 Các ràng buộc
và các trigger
<Kiểm tra giao diện>
<Kiểm tra reports>
(ở cột ‘Phơng thức/số hiệu T.L’ nếu phơng thức thực hiện phải mô tả quá dài thì
chuyển sang điền vào BM.PM.05.06)
