[Project]

DETAIL DESIGN DOCUMENT

Data design

Project Code:

Document Code: <Project code>-DD –

v<Version>

<Location, issued date of the Document>

RECORD OF CHANGE

*A - Added M - Modified D – Deleted

Effectiv Changed Items A* Change Description New

e Date M, Versio
D n
SIGNATURE PAGE

ORIGINATOR:<Name> <Date>

<Position>

REVIEWERS: <Name> <Date>

<Position>

<Name, if it’s needed> <Date>

<Position>

APPROVAL: <Name> <Date>

<Position>
TABLE OF CONTENTS

1 INTRODUCTION..................................................................................5

1.1 Purpose........................................................................................................ 5
1.2 Definitions, Acronyms and Abbreviations.....................................................5
1.3 References................................................................................................... 6
1.4 Overview...................................................................................................... 6
2 DATABASE.........................................................................................7

2.1 ERDs............................................................................................................ 7
2.2 XXX table..................................................................................................... 8
3 FILE DESIGN......................................................................................9

3.1.1 XXX file............................................................................................................. 9

4 CODE DESIGN..................................................................................11

4.1 Customer Code.......................................................................................... 11

5 OTHER CONSIDERATIONS.................................................................12

6 APPENDIX........................................................................................13

6.1 Data format symbol...................................................................................13

1 INTRODUCTION

1.1 Purpose

This part will give general description of the document including:

 Purpose of document.

 What are contained in the doc

 Reader of document

 Other description about scope of document, limitation,...

Ex.

XXX data design document describes structure of database and file structure of system including internal file structure as
well as interface file structure. Developer and tester will base on this design to implement and unit test.

1.2 Definitions, Acronyms and Abbreviations

Abbreviations Descriptio Commen

n t
P/F Key Primary/ Foreign key Use to indicate that a field is a primary or foreign
key in table
1.3 References

List all the reference document such as: other document of the system, or the technical article,...

Document Number Titl

e
Class design document
Screen design document

1.4 Overview

General overview of the detail design such as what is the structure of the document
2 DATABASE

2.1 ERDs

<Entity relationship diagrams>

Table Table
Order OrderDetail

Table Table
Products
Customer

<List of tables and brief description>

No Table Name Descriptio

n
CustomerMaster
Order Order made by customer to buy one or more products
OrderDetail Detail information of each products in order
ProductMaster Contains all products of the store
2.2 XXX table

No Field Name Type Length Size Null Unique P/F Key Default Descriptio
n
01 xxxCode int 4 x P Code of xxx, Auto number
02 yyyCode int 4 x F Code of yyy.
3 FILE DESIGN

<File List>

No File Name File type Descriptio

n
name of file <Fixed length>

<CSV>

3.1.1 XXX file

Format of file

<Describe the file format with the sequential of field>

 Fields

<if this file is CSV File>

No Field Name Format Descriptio

n
special format
such as date
“mm/dd/yy”

<If this file is fixed length>

No Field Name Format Start End Descriptio

n
4 CODE DESIGN

<Design the format of codes ex. Customer codes, product codes that are complicated and contains meanings. These codes are
fields in database or files. >

<List of code>

No Cod Descriptio
e n
01 Customer code Code of customer in the system.

4.1 Customer Code

Customer code has the form of AAAMMYYYY000 which

AAA: 3 required characters stand for Province of customer such as HAN: Ha Noi, DAN: Da Nang, HCM: Ho

Chi Minh City MM: The month that customer registers; can be 01 to 12

YYYY: The year that customer registers; it is in 4-character form: ex. 2004

000 is the sequential number start from 0; each customer has one number: “000”; “001”

example of customer code: HAN121999001

5 OTHER CONSIDERATIONS
[This section provides a description of other design elements that were considered as alternatives in selection process for the
above database design, i.e. a brief explanation of advantages and disadvantages of the selected entity relationships and/or
database implementation in comparison with others. It should be a clear answer to the question why the above data design is
selected for this system, not the others.]
6 APPENDIX

6.1 Data format symbol

Following symbols are used to describe format of data field in files as well as in tables.

Symbol Descriptio
n
# Digit placeholder.
. Decimal placeholder.
, Thousands separator.
: Time separator.
/ Date separator.
\ Treat the next character in the mask string as a literal. This allows you to include the '#', '&', 'A', and '?' characters in the
mask. This character is treated as a literal for masking purposes.
> Convert all the characters that follow to uppercase.
< Convert all the characters that follow to lowercase.
A Alphanumeric character placeholder (entry required). For example: a – z, A – Z, or 0 – 9.
a Alphanumeric character placeholder (entry optional).
9 Digit placeholder (entry optional). For example: 0 – 9.
0 Digit placeholder (entry required). For example: 0 – 9.
C Character or space placeholder (entry optional). Valid values for this placeholder are ANSI characters in the following ranges:
32-126 and 128- 255.
& Character placeholder (entry required). Valid values for this placeholder are ANSI characters in the following ranges: 32-126
and 128-255.
? Letter placeholder. For example: a – z or A – Z.
Literal All other symbols are displayed as literals; that is, as themselves. bound in “” like “ABC”