DESIGN DOCUMENT
1. Overall presentation
Cover page
Title page:
project name
name of the client organization
name of the group and possibly the names of group members
date of the document
version of the document
Contents page
N.B. 1. Be consistent with use of headings, page numbers, labeled diagrams, etc.
2. Check spelling and grammar
2. Executive summary
Purpose of the document
A summary of the whole document: what is presented in each section.
3. Introduction
Should include, but not be limited to:
Description of the scope and purpose of the document
Description of the document's intended audience
Identify the system/product using any applicable names and/or version numbers
Provide references for any other pertinent documents such as:
Related and/or companion documents
Prerequisite documents
Documents which provide background and/or context for this document
Documents that result from this document (e.g. a test plan or a development plan)
Define any important terms, acronyms, or abbreviations
Summarize the contents of this document
4. Data Design
Review and develop data objects, relationships, data flow and content
Identify all data structures and the operations performed on them
Create the data dictionary to represent the relationships among data objects and the
constraints on the elements of the data structure
If using a database, perform database design
Data-to-Process CRUD Matrix if applicable
5. Process Design
Detailed description of each software component:
Process models, either traditional (DFDs & all required levels) or event-driven
(decomposition diagram, event response diagrams and use case lists etc.
Process descriptions (using structured English), expanded use-case narratives (if not
already done), possibly decision tables
Address processing controls
Include algorithms, as well as an overview of the components using structure charts,
hierarchy charts, etc.
If using OOM/P you will need class diagrams and sequence diagrams, either high-level with
a data dictionary, or low-level which includes all the definitions.
6. Architecture/Infrastructure Design
Define the architecture of the system
Provide an architectural diagram if applicable (this can include the structure of static web
pages, a guide to navigation).
Additional software components as necessary
Infrastructure requirements: capacity, performance, integration & compatibility, platform
strategy, security, back-up & recovery, scalability, future proofing
Discuss alternative designs
7. Interface Design
The design of the interfaces between software modules:
The design of interfaces between software and non-human (external) entities.
The design of the interface between human and computer (HCI)
You should provide mock screen-shots of the interfaces of the system you intend to create.
Interface specifications: input/output controls, formatting, etc.
8. Appendices
Appendix A: Deliverable Task Breakdown Statement: completed, signed, scanned and
copied into document
Appendix B: Glossary/data dictionary
Appendix C: Glossary of terms and definitions and acronyms
Appendix D: Any other information you consider necessary to include
MARKING SCHEDULE
Sections Marks
1. Overall 5
2. Executive summary 6
3. Introduction 5
4. Data Design 20
5. Process Design 20
6. Architecture / Infrastructure Design 20
7. Interface Design 20
8. Appendices 4
Total marks 100
- Now you have three documents submitted. Each one has a different style in regards to (font,
colors, headings, …). You should use one formatting style for all.
- Data design, you should introduce the section.
- Inbox and Search, are not separate entities, they are procedures in the view level.
- Same comments about the ERD, you should refactor it, according to the implementation.
- You don’t have admin role or admin login in your system, update the dataflow diagram.
- After the implementation update your diagrams accordingly.
-
