CS148
X-Culture
Communications
Final Project Specification Document
Isaiah Cory
12-11-2013
1
X-Culture Communications
Contents
Time Log ........................................................................................................................................................ 1
Introduction .................................................................................................................................................. 2
Purpose ..................................................................................................................................................... 2
Definitions, acronyms, and abbreviations ................................................................................................ 2
Overview ....................................................................................................................................................... 2
Overall Description ................................................................................................................................... 2
E-R Diagram............................................................................................................................................... 3
Data Dictionary ......................................................................................................................................... 3
tblClient .................................................................................................................................................... 3
tblInterpretation.......................................................................................... Error! Bookmark not defined.
tblRequest .................................................................................................. Error! Bookmark not defined.
tblTranslation ............................................................................................. Error! Bookmark not defined.
Schema ...................................................................................................................................................... 4
Storyboard ................................................................................................................................................ 6
Specific Requirements .............................................................................................................................. 7
Time Log
Date
11/6
11/9
11/12
11/16
11/21
11/23
11/24
11/25
11/26
11/27
11/30
12/1
12/3
12/4
Time Spent
(hours)
2
3
1
1
1
3
2
3
3
2
2
3
6
4
Description
Author
Estimated time to complete assignment is _ 60 _ hours
Project Spec 1.0 document
HTML coding
HTML Forms
Database tweaking
PHP includes
HTML + CSS
HTML Forms
HTML Forms + CSS
HTML + Forms + CSS
Forms HTML
Forms HTML + PHP
Forms PHP
Forms PHP
Forms PHP + CSS
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
Isaiah Cory
2
12/6
12/10
2
5
Total
43
CSS styling for entire website
mySQL joins: learning and implementing in various ways;
final testing before presentation
Isaiah Cory
Isaiah Cory
Introduction
Purpose
The purpose of this document is to describe the project specification for a website that would serve a
(mock) U.S. company that specializes in providing cross cultural communication services to businesses
working in Mexico or with Mexican companies.
Definitions, acronyms, and abbreviations
HTML – Hypertext markup language – used to define your content.
PHP – Personal Home Page – language that helps to customize html.
CSS – Cascading Style Sheets – used to define the look of a web site.
Overview
This following section contains the necessary information structure and UI concept to create the web
site. It has an overall view of what the site purposes to accomplish; it lays out the data dictionary and
schema; it shows the original concept for the website as well as a current view; it denotes the certain
requirements specific to this project.
Overall Description
The website is a generic website that could be used for a company seeking to deliver cross cultural
communication services and coaching to companies looking to engage in business or open up business
communications in Mexico. The website will allow potential clients to request services as well as make
more general requests or comments. It will also allow administrators to access the requests to view or
delete submissions.
3
E-R Diagram
Data Dictionary
tblClient
Table comments: tblClient
Column
Type
pkClientID
int(11)
fldFirstName varchar(20)
fldLastName varchar(30)
fldOrganization varchar(30)
fldAddress
varchar(50)
fldCity
varchar(20)
fldState
varchar(20)
fldCountry
varchar(20)
fldPostalCode varchar(11)
fldEmail
varchar(65)
fldPhone
varchar(20)
Null
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
tblInterpretation
Table comments: tblInterpretation
Default
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
Comments
MIME
4
Column
Type
Null
pkfkRequestID
int(11)
No
fldMode
varchar(10) Yes
fldAppointmentDate
date
Yes
fldStartTime
varchar(15) Yes
fldEndTime
varchar(15) Yes
fldTimeZone
varchar(100) Yes
fldAppointmentAddress varchar(255) Yes
Default
Comments
MIME
NULL
NULL
NULL
NULL
NULL
NULL
tblRequest
Table comments: tblRequest
Column
Type
Null Default
pkRequestID int(11)
No
fkClientID
int(11)
No
fldTimestamp datetime
No
fldComment varchar(250) Yes NULL
fldSubject
varchar(50) Yes NULL
Comments
MIME
tblTranslation
Table comments: tblTranslation
Column
Type
Null
pkfkRequestID
int(11)
No
fldDocumentTitle
varchar(30) Yes
fldDocumentType
varchar(30) Yes
fldDocumentWordCount int(11)
Yes
fldDateRequired
date
Yes
fldDocumentUpload
varchar(255) Yes
Default
NULL
NULL
NULL
NULL
NULL
Schema
CREATE TABLE tblClient(
pkClientID INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
fldFirstName VARCHAR(20),
fldLastName VARCHAR(30),
fldOrganization VARCHAR(30),
fldAddress VARCHAR(50),
fldCity VARCHAR(20),
fldState VARCHAR(20),
Comments
MIME
5
fldCountry VARCHAR(20),
fldPostalCode VARCHAR(11),
fldEmail VARCHAR(65),
fldPhone VARCHAR(20)
);
CREATE TABLE tblRequest(
pkRequestID INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
fkClientID INT(11) NOT NULL REFERENCES tblClient(pkClientID),
fldTimestamp DATETIME NOT NULL,
fldComment VARCHAR(250),
fldSubject VARCHAR(50)
);
CREATE TABLE tblTranslation(
pkfkRequestID INT(11) NOT NULL
fldDocumentTitle VARCHAR(30),
fldDocumentType VARCHAR(30),
fldDocumentWordCount INT(11),
fldDateRequired DATE,
fldDocumentUpload VARCHAR(255)
);
PRIMARY KEY REFERENCES tblRequest(pkRequestID),
CREATE TABLE tblInterpretation(
pkfkRequestID INT(11) NOT NULL PRIMARY KEY REFERENCES tblRequest(pkRequestID),
fldMode VARCHAR(10),
fldAppointmentDate DATE,
fldStartTime VARCHAR(15),
fldEndTime VARCHAR(15),
fldTimeZone VARCHAR(100),
fldAppointmentAddress VARCHAR(255)
);
6
Storyboard
7
Specific Requirements
1. Login – Admins must be able to access the database information from the website in a way that
allows them to add new records, update existing records, and delete records.
2. Forms – There must be a variety of forms that allows clients to request specific services or make
a general comment to the company. Form input needs to pass validation and if not, appropriate
error messages will be displayed. Form information must be emailed to at least one recipient.
3. Validation – All pages must pass W3 HTML and CSS validation.
4. Github – Use github throughout the project.