Requirement of Final Project Report

CIS408 SS Chung

Write A Software Specification for your Final Group Project.

Group Project Presentation Should include the followings in brief (and Project

Specification Report should have them in detail):

1. Explain Project Features/Functions

2. Your Platform: How you set up (install) your platform -- Document every

installation details, references, links where you download your web server,

database server, any packages, library or Cloud to build your project.

3. Project Software Architecture (Design) with each software component (For

example, 3tier Client-Server where my client side and server side codes) Specify

your source file names in each component of your project.

4. Demo explaining each component (with source code files ) in your Software

Architecture (design)

5. Source Codes for every component of your project with Clear instructions on how

your project works with all your input and output files

6. Future work to extend if any

7. REFERENCES (Very Important !) : All the sources (web site links and

documents, books) you look up to build your project.

First, all the descriptions in a Software Specification have to be

very specific and precise and Instructional with precise module names

in which files in which directory paths. It should NOT be in high

level nor in promotional tone (like saying that this frame work is

easy and hide everything, blah blah).

1. Description on Your Platform and Frameworks that you used to build

your server side code.

- Platform:

For example, MS ASP .NET Platform with Entity Framework 6 Using MVC5,

1. You have to clearly specify and give a brief

introduction/description on the specific Platform with specific

Framework. No need to write in detail if there are direct reference

links for the description and instructions for this. Put the reference

and source sites for manual, set up instruction, documentation.

2. Add the detailed set up procedure to set up this framework on this

platform. Start from VS, write instructions on what to be done to set

up your platform with the specific frameworks. For the critical parts,

try to be step by step with screenshots (you can put the link to the

set up instruction site for this if there is). However, a clear

instruction to the critical parts need to be specified here. For

example, how to create a project on Entity Framework using MVC5, what

exact changes should be made in Web Config file to connect your SQL

Server, and so on.

- Frameworks:

Several Frameworks on top of the above Platform you started your

server side controller for your project would be, for example: AJAX,

Angular JS, LingQ

the same instructions to set up (include) such frameworks are needed

here as well in Specific Codes. You can copy and paste from your

codes. It will be very simple but very important information to

explain your codes.

- Your Controller Code structure with interaction with UI (Bootstarp

codes) and Database side

No need to explain the entire code module structures here for simplicity.

Pick code module paths for two common functionality, one for Retrieval

and another for Insert to explain the code structure with an example

case. Enrollment or Employee table look up, for example.

First Explain general common code/module structures in ASP .NET Web

application platform in terms of file extensions and file paths to

show corresponding UI and the controller side module, and a database

related modules/files. Pick one example controller module to show all

the related files to explain the general common structure. You can

copy and paste or screen captures of each file path in your package in

the address bar to explain.

Pick one example case for retrieval case:

1. Show the Code walk through starting from User's interaction on the

UI page with corresponding Bootstrap code snippet of the Foam element

that is in a specific file name in a specific file path to request.

2. Briefly explain how the controller side module work in a specific

file name and present the full controller codes and show how the

interaction to database side is done in terms of code modules in a

specific file name in path.

3. Present how the database connection and querying and getting

response to process and display the result in the page in terms of

code walk through in a specific module name and file name.

Do the same procedure 1, 2, 3 for an example for an insert case.

If your specification is good and clear in these two examples, then

the rest of your software structure will become self explanatory, you

don't have to worry about the rest of them. If you have something

tricky or different, then write instructions briefly about those

particular parts.

Submission:

Turn in your Output BOTH In Class and on Blackboard as follow:

Only ONE Submission Per Group is required with Member Names and IDs on the cover

page of the project report.

On Blackboard:

1. Create one zip file that includes:

Final Project Report (in Doc) as specified above in doc file. Add introduction and

description of your project, instructions for the procedures to show how you set

up your platform, systems and tools you use for the project, the steps on how

you install them, all the source links and references (websites that you

downloaded your systems or tools or any related info) and copy and paste all

your client side and server side codes under file names

All your source code files

Write readme file to instruct how to run your codes,

Your input and output files.

Your Presentation Slides (in both ppt and pdf)

2. Turn in your zip file (your project report and presentation slides) on blackboard

by the last day (Friday) of the semester before the final exam.

In Class (On The Final Exam Day)

Submit a Printout of your Project Report and Presentation Slides in the Final day.

Note that you will evaluate the contribution of your project group member at the

end of project report. It will be counted to your project score.