Scribd
Upload
286 views5 pages

SWP391-AppDevProject - Design Template

This document provides an overview of the software design for a project. It outlines the code packages and database schema. It then describes in detail the design of two features, including class diagrams, class specifications, sequence diagrams, and database queries used. Finally, it lists the database tables with descriptions of fields for each.

Uploaded by

Nguyen Phuong Nam (K14 HL)
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
286 views5 pages

SWP391-AppDevProject - Design Template

This document provides an overview of the software design for a project. It outlines the code packages and database schema. It then describes in detail the design of two features, including class diagrams, class specifications, sequence diagrams, and database queries used. Finally, it lists the database tables with descriptions of fields for each.

Uploaded by

Nguyen Phuong Nam (K14 HL)
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 5

<<PROJECT NAME>>

Software Design Document

– Hanoi, August 2019 –


Table of Contents
I. Overview..................................................................................................................................................3
1. Code Packages.....................................................................................................................................3
2. Database Schema................................................................................................................................3
II. Code Designs...........................................................................................................................................4
1. <Feature/Function Name1>.................................................................................................................4
a. Class Diagram...................................................................................................................................4
b. Class Specifications..........................................................................................................................4
c. Sequence Diagram(s).......................................................................................................................4
d. Database queries.............................................................................................................................5
2. <Feature/Function Name2>.................................................................................................................5
III. Database Tables......................................................................................................................................5
1. <Table name 1>...................................................................................................................................5
2. <Table name 2…>.................................................................................................................................5
I. Overview
1. Code Packages/Namespaces
[Provide the package diagram for each sub-system. The content of this section including the overall
package diagram, the explanation, package and class naming conventions in each package. Please see
the sample and description table format below – following Java project naming convention]

Package descriptions & package class naming conventions


No Package Description
01 <Package <Description of the package>
name> <Class naming convention>
02

2. Database Schema
[Provide the tables relationship like example below – following MySQL database naming convention]

Table descriptions & package class naming conventions are as below


No Table Description
01 <Table name> <Description of the table>
- Primary keys: <<list of primary key fields>>
- Foreign keys: <<list of foreign key fields>>
02
II. Code Designs
1. <Feature/Function Name1>
[Provide the detailed design for the function <Feature/Function Name1>. It include Class Diagram, Class
Specifications, and Sequence Diagram(s)]

a. Class Diagram
[This part presents the class diagram for the relevant feature]

b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

XYZ Class
[Provide the detailed description for the class methods]
No Method Description
01 <method name> <Description of the method, including the inputs, outputs & internal
method processing>

ABC Class
Class Methods
[Provide the detailed description for the class methods]
No Method Description
01 <method name> <Description of the method, including the inputs, outputs & internal
method processing>

c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]
d. Database queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]

2. <Feature/Function Name2>
…

III. Database Tables


1. <Table name 1>
[Give some lines about the table here>>
[Table fields, in the form of table format as below]
# Uniq Not
Field name Type Size PK/FK Notes
ue Null
1 Field name1
2 Field name2

2. <Table name 2…>

You might also like