Design Document Template - Software Engineering - Review Sheet | CS 389, Study notes of Software Engineering

Material Type: Notes; Class: Software Engineering; Subject: Computer Science; University: Pace University-New York; Term: Spring 2005;

Typology: Study notes

Pre 2010

Uploaded on 08/09/2009

koofers-user-ru5
koofers-user-ru5 🇺🇸

10 documents

1 / 3

Toggle sidebar

This page cannot be seen from the preview

Don't miss anything!

bg1
Design Document Template
Version: 3/6/05
History:
- Empty
This document is a template of design document designed for cs 389, Spring
2005.1
1. Introduction
Purpose of this document
This is a design document…
It was realized…
Description of the organization of the document
2. Architecture Design
The architectural design is the design of the entire software system; it gives a high-level
overview of the software system, such that the reader can more easily follow the more
detailed descriptions in the later sections. It provides information on the decomposition of
the system into modules (classes), dependencies between modules, hierarchy and
partitioning of the software modules.
3. Database Design
The database design specifies how the date of the software is going to be stored.
Tables schemas
The complete (compilable) set of CREATE TABLE statements (and other SQL
statements) that declare the database schema, including integrity constraints, domain
specifications, assertions, and access privileges -- documented in a template with the
intended use of each table and column.
This is a suggested template you may use2:
Name of the table
Description This table describes…
1 You can use your own font, font style, font color… The document is not double-spaced.
2 You may define your own template. This is only a suggestion.
pf3

Partial preview of the text

Download Design Document Template - Software Engineering - Review Sheet | CS 389 and more Study notes Software Engineering in PDF only on Docsity!

Design Document Template

Version: 3/6/ History:

  • Empty This document is a template of design document designed for cs 389, Spring 2005.^1 1. Introduction Purpose of this document This is a design document… It was realized… Description of the organization of the document 2. Architecture Design The architectural design is the design of the entire software system; it gives a high-level overview of the software system, such that the reader can more easily follow the more detailed descriptions in the later sections. It provides information on the decomposition of the system into modules (classes), dependencies between modules, hierarchy and partitioning of the software modules. 3. Database Design The database design specifies how the date of the software is going to be stored. Tables schemas The complete (compilable) set of CREATE TABLE statements (and other SQL statements) that declare the database schema, including integrity constraints, domain specifications, assertions, and access privileges -- documented in a template with the intended use of each table and column. This is a suggested template you may use^2 : Name of the table Description This table describes… (^1) You can use your own font, font style, font color… The document is not double-spaced. (^2) You may define your own template. This is only a suggestion.

Attribute Description Type Examples of values Id Id of a student Integer Between 1 and 999999999 Name Name of a student String John Primary Key Foreign Keys SQL Code Tables data: The tables have to be populated by you and your client. Each table must contain an appropriate number of data. The contents of the tables has to be provided (in an organized way.) SQL queries: Provide all SQL queries that you will need. Transactions implementation: Explain how you will implement the ACID (atomicity, consistency, isolation and durability) properties of transactions (programs that access databases.)

4. Graphical User Interface  Provide, in an organized way, the pictures of all the forms in the graphical user interface with a reference to the functional requirement it implements. You may use html to present the graphical user interfaces.  For each form in the graphical user interface, provide: o The names of the controls and fields on that form, o The names of the events, methods, or procedures that cause that form to be displayed, and o The names of the events, methods, or procedures triggered by each control. 5. Class Diagram and Classes Provide a class diagram and an inheritance tree/diagram. Each method has to be defined^3 : 1. Method Name 2. Parameters, each documented with its intended use 3. Return Value, suitably documented 4. Informal description of what the procedure does 5. Data structure and tables it accesses (^3) Method can be presented in templates or this information can be available in the Java code directly.