SWD.4.0 FINAL
24 April 1997
SOFTWARE DESIGN DOCUMENT
FOR THE
MJY TEAM
SOFTWARE RISK MANAGEMENT WWW SITE
Prepared for:
Dr. Richard Bechtold
SWSE 625
Prepared by:
MJY Team
George Mason University
Approved by:
P. McNeece
MJY Program Manger
RECORD OF REVISIONS
| Revision |
Description |
Date |
| SWD 0.0 |
Initial Draft Version |
February 25, 1997 |
| SWD 1.0 |
First Baseline Version |
March 11, 1997 |
| SWD 2.0 |
Second Baseline Version |
April 4, 1997 |
| SWD FINAL |
Final Baseline Version |
April 24, 1997 |
MJY TEAM SOFTWARE DESIGN DOCUMENT
PROJECT REQUIREMENTS/FUNCTIONAL SPECIFICATION
The following lists the project requirements, which double as the external
functional specification:
- Introduction to Software Risk Management
section
- Link(s) to original Software Risk Management Papers
- Link(s) to Software Risk Management Material
in the Public Domain
- Bibliography of articles and publications
related to Software Risk Management
- Link(s) to Tools used for Software
Risk Management
- Link(s) to articles and publications related to lessons
learned in Software Risk Management
- Levity section containing humorous pictures
or articles related to Software Project Management
- Link(s) to WWW search engines
with Software Project/Risk Management keywords
- Bulletin Board for interested
users to interact with others
- MJY team draft documentation review section
DETAILED SOFTWARE DESIGN
Tools:
HTML was chosen as the development Markup Language for its wide
use and ease in learning. Several editors are being used, including Netscape
Navigator Gold 3.0, Microsoft (MS) Word 7.0 with Internet Assistant 2.04z
for conversion of MS Word documents, MS Excel 7.0 with Internet Assistant,
MS Project 4.0 and the Project to HTML conversion program, as well as Notepad
and the Borland C++ compiler. No special browser-specific elements will
be used in development since more of an audience can be accommodated with
standard HTML.
CGI scripts written in Perl are being used to implement the
bulletin board feature. A freeware user interaction package of scripts
is being used to avoid the overhead of developing this application in the
limited time available.
Tasks:
Task: Setup directory structure
This task involves creating the actual source directories and files
on the WWW server. Original on-site files will be linked to each other
as necessary so the basic structure is in place, even while the data is
in flux.
Directory Hierarchy:
Set up directory hierarchy for web site files in html directory ( /home/html/kjordan/
)
- swse625/ - contains main site and subsection HTML files and
subdirectories:
- chat/ - contains files necessary to implement bulletin board
functionality
- wwwboard/ - contains files necessary to implement bulletin board
functionality
- messages/ - directory containing all bulletin board messages
- wwwboard.html - the main bulletin board file
- faq.html - frequently asked questions file for the bulletin
board
- data.txt - text file holding latest message number for use in
naming next message file
- passwd.txt - file containing password for administration tool
for the bulletin board
- index.html - security file used to prevent direct access to
directory files
- index.html - security file used to prevent direct access to
directory files
- docs/ - contains the MS Word, MS Excel, MS Project and MS PowerPoint
documents required for class
- htm/ - contains HTML versions of documents in docs directory
- images/ - contains all picture format files used in the site
- index.html - main site file explaining site purpose with links
to subsections and papers
- intro.html - introduction to Software Risk Management section
- sites.html - links to related site, tool sites, other SWSE 625
team sites, and web searches
- bib.html - bibliography list, linked from index.html
- levity.html - levity section, linked from index.html
- lessons.html - lessons learned section, linked from index.html
- teamdocs.htm - MJY Team internal documents Table of Contents,
linked from index.html
- *All other sets of links will be part of the sites.html file,
unless the list grows large enough to warrant separation.
Set up directory hierarchy for web site files in cgi-bin directory (
/home/html/cgi-bin/kjordan/ )
- wwwboard.pl - Perl file to implement bulletin board functionality
- wwwadmin.pl - Perl file to implement bulletin board administration
tool functionality
Task: Search for related links
This task requires WWW search time for ALL MJY Team members in order
to read enough on searched sites to determine the site's usefulness to
the project and its worthiness for inclusion.
The following requirements are included in this task, with the minimum
number required listed first.
- (10) Link(s) to Software Risk Management Material in the Public Domain
- (5) Link(s) to Tools used for Software Risk Management
- (10) Link(s) to articles and publications related to lessons learned
in Software Risk Management
- (5) Link(s) to WWW search engines with Software Project/Risk Management
keywords
Task: Addition of standard HTML links and references to site
This task refers to the actual addition of HTML lines to the source
files in order to add a link visibly to the site once it has been deemed
worthy of inclusion.
The following requirements are included in this task, with the minimum
number required listed first.
- (10) Link(s) to Software Risk Management Material in the Public Domain
- (5) Link(s) to Tools used for Software Risk Management
- (10) Link(s) to articles and publications related to lessons learned
in Software Risk Management
- (5) Link(s) to WWW search engines with Software Project/Risk Management
keywords
Task: HTML markup of outside documents (with links incorporated
where possible)
This task refers to the acquisition of outside documents, pictures,
and a compilation of the MJY Team final paper's bibliographies which will
be converted to HTML. These sections may all end up using original MJY
Team materials, but it is anticipated that some material will be from outside
sources and will require conversion for inclusion in the site.
The following requirements are included in this task, with the expected
number of text pages listed first.
- (2) Introduction to Software Risk Management section
- (3) Bibliography of articles and publications related to Software Risk
Management (from final papers)
- (2) Levity section containing humorous pictures or articles related
to Software Project Management
Task: CGI scripts for interaction, possibly from an outside
source.
This task refers to the implementation of the bulletin board function.
A freeware set of scripts and files from Matt's Script Archive (WWWBoard
2.0) will be tailored for use in the web site, minimizing development time.
The following requirement is included in this task.
- Bulletin board for interested users to interact with others
Task: HTML markup of internal documents, with revisions available
This task involves storing Word 6.0 and HTML versions of all revisions
of internal project documents for download and view, with download accessibility
to at least the MJY Team members, and view accessibility to all as a useful
exercise in project progression.
The following requirement is included in this task, with the expected
number of text pages listed first.
- (150) MJY team draft documentation review section
Task: HTML markup of final papers
Each MJY Team member is required to write a 10 page (or so) paper on
a software project management topic that will undoubtedly be in Word 6.0
format and will need to be converted to HTML in order to be viewed here.
This task is the conversion of these large documents.
The following requirement is included in this task, with the expected
number of text pages listed first.
- (70) Link(s) to original Software Risk Management Articles
| Task |
Level of Effort |
Who |
Start week |
Due week |
| Setup directory structure |
0.5 hours |
Developer |
2/17/97 |
2/24/97 |
| Search for related links |
1 hour for every useful link (5 links added per week)
(10 + 5 + 10 + 5) = 30 hours total, 5 hours per week
|
MJY Team |
2/17/97 |
4/14/97 |
| Addition of standard HTML links to site |
0.25 hours for every 5 links (5 links added per week)
(10 + 5 + 10 + 5) * (0.25)/5 = 1.5 hours
|
Developer |
2/17/97 |
4/14/97 |
| HTML markup of outside documents |
0.25 hours for every full page of text/Word documents to
be converted to HTML
(2 + 3 + 2) * (0.25) = 1.75 hours
|
Developer |
2/17/97 (Levity, Intro),
4/14/97 (Bibliography)
|
4/14/97 (Levity, Intro),
4/21/97 (Bibliography)
|
| CGI scripts for interaction, possibly from an outside source.
|
5 hours for research into outside source scripts
5 hours to modify and test outside version
= 10 hours
|
Developer |
2/17/97 (research),
2/24/97 (develop/modify)
|
2/24/97 (research),
3/10/97 (develop/modify)
|
| HTML markup of internal documents, with revisions available
|
0.25 hours for every full page of text/Word documents to
be converted to HTML
(Ave 3 pages * 10 docs * 5 revisions) * 0.25 hours/page = 37.5 hours
total, 3 hours per week
|
Developer |
1/27/97 |
4/21/97 |
| HTML markup of final papers |
0.25 hours for every full page of text/Word documents to
be converted to HTML
(10 pages * 7 papers) * 0.25 hours/page = 17.5 hours
(Unless all paper formats are REALLY simple, I'm going to need help
to do this in a week!)
|
MJY Team |
4/21/97 |
4/28/97 |
Software Project Management /
Comments? /
Back /
Last Updated: April 30, 1997