Download Software Implementation Document - Wilma

Software Implementation Document
Course Project
Murhaf Mustafa - Implementation Leader
Approvals
Name
Date
Signature
A. Mushtaha 20/06/2003
M. Mustafa
21/06/2003
Revision History
21/06/2003 Murhaf Mustafa First draft of document
Contents
1.
2.
3.
4.
5.
Introduction
o Purpose
o Definitions, acronyms, and abbreviations
Assignments of programming work
Coding Conventions:
o class name
o class method
o variable
o constant (static) identifier
o parameter
o source files
Notes for the Implementation
Online documentation
Introduction
Purpose
This Document specifies some code segments assigned to each team member, as it tell
the naming convension for the source code of project.
Definitions, acronyms, and abbreviations
Acronyms










SID: Software implimentation Document - this document
SPMP: Software Project Management Plan - a document that sets the
structural layout of the project (e.g. deadlines)
UML: Unified Modeling Language
HTML: Hypertext Markup Language is the language used to format
documents for use on the World Wide Web.
XML: Extensible Markup Language. It is designed to create grammars
which describe documents so that they can be used over networks such
as the internet.
CGI: Common Gateway Interface described the format of data when it
is passed from a Web server to a sever-side script.
SQL: Structured Query Language. A type of programming language
used to construct database queries and perform updates and other
maintenance of relational databases.
SDD: Software Design Document - This document.
SRS: Software Requirements Specification - Specifies customer and
detailed requirements.
DB: database
Assignments of programming work
:
To make the work on the project faster, and for good performance. Each segment of
programming code will be inspected by another team member once written.. We
divided our coding in the project as following:
 A. Mushtaha will write the Database creation code and sample database.
 M. Mustafa will write the converting the retrieval data to XML format.
 A. Mushtaha will write to the style sheet document ( XSL document ).
 M. Mustafa will write the code of the CGI file, to present the web page as html
at the client side.
 A. Mushtaha will design the website of the project.
Each programming team member has to maintain his programming work within a
personal software document. After each programming session he has to modify it
depending on the work done. Every part will be tested separately, after all the
segments of the code are completed, the team members will combine them all to
gather to perform one application
Coding Conventions:
Naming Conventions
class name:
a noun, or a concatenation of multiple nouns, beginning with a capital, expressing as
mush the essence and meaning of the class
class ClassName {
...
}
example: class Error
class method:
verb starting with a lowercase letter and a capital starting letter for each interior word
use -get, -set and is- accessormethods
String getName() {
void
setName(String name) {
bool
isEmpty() {
example :
void StartPage();
variable:
starting with a lowercase letter, multiple words can be used concatenated to each other
each interior word must begin with a capital
int
size;
float
mySize;
example :
string title;
string body;
constant (static) identifier:
uppercase words concatenated by use of an underscore
static const int
MY_SIZE=4;
parameter:
use one lowercase word, otherwise use an abbreviation and explain where it stands for
in the documentation
source files:
All files containing source code must end with the '.C' suffix.
Notes for the Implementation:




The comments will be added to code files, so it'd be easier in the future to
make modification , of to find bugs in the code.
There will not be a specific pattern as the program is not that commix or big.
the codes related to the same implementation function will be organized in one
baggage, example: the files that resolve user query, and the files open and
reset and create sample data will be in one package. And the files of the CGI
interface of the dynamic web site will be gathered in one baggage, and so on.
We will reach the functions of the classes in another packages with name
spacing, for example : Sql::Command u(db,txt);
Online documentation
As the code is changing very often , the up-to-date documentation are available on the
following link:
http://wilma.vub.ac.be/~abmushta/viewcvs/viewcvs.cgi/Project/Docs/
Software Engineering Master Group 2003-06-21