Ricardo Rodriguez



1. Introduction
1.1 Purpose

- The purpose of the system will be to provide users a free and innovative way of search for information related to baseball (E.g. baseball statistics, baseball rules, history of baseball, upload videos and pictures).

1.2 System Overview

It will consist of various small independent subsystems that combined together will build up the larger systems. The complete system will be divided into small independent modules which ay further be divided if needed be. Such independent modules will be designed and coded separately and are later combined to make the system functional. I believe that for better understanding of the system, it should be made as a hierarchy of modules. Lower level modules are generally smaller in scope and size compared to higher level modules and serve to partition processes into separate functions. I will try to contain the number of instructions in a module so that the module size will generally be small. I will work with not duplicating functions in separate modules, but instead establish a single module that will call the one needed at any time.

1.3 Definitions and Acronyms

None at this time.

2. Design Considerations
2.1 Assumptions

-What data to input

-What medium to use

-How data should be arranged

-How data should be coded i.e. data representation conventions.

-The dialogue to guide users in providing input i.e. informative messages that should be provided when the user is entering data. Like saying, "It is required. Don't leave it blank."

2.2 Constraints


- HTML code will be used.

- Most of code will be written in PHP.

2.3 System Environment

- Accessible to anyone who can log onto the World Wide Web using a standard browser that is version 4.0 or higher. The inventory properties should be maintained in a relational database, such as Oracle. A combination of standard HTML and a scripting language for web application, such as Cold Fusion of MS Server Pages, will be taken under consideration be considered in developing the web page interface.

2.4 Design Methodology

- Small independent subsystems that combined together will build up the larger systems. The complete system will be divided into small independent modules which ay further be divided if needed be.

2.5 Risks


- Failure to update database.
- Security

4. Architecture
4.1 Overview

User Interface

User interface will deal with requests of users.

Uploader

Will control what is being uploaded to server.

User administration

Will handle user authenticity and accounts created


4. Detailed System Design
4.1 User Interface
4.1.1 Classification

- Use if HTML and PHP

4.1.2 Definition

- User interface will be able to handle the requests of the user

4.1.3 Responsibilities

- If done correctly is should be able to display the desired request from users.

4.1.4 Constraints

- User will only access what is on the database. Outside of the database content would be limited or not accessible.

4.1.5 Uses/Interactions

- Will be accessed by people of all ages, therefore it will be simplistic in many ways not leaving out the human element.

4.1.6 Processing-

It will process all available requests from users.

5. Database Schema

Database

So far I believe only one database will be needed to hold the information. I would only need two tables for user inormation and another to keep track of what the user has uploaded.

List any fields that will be needed, for each one including table name, table description, and related tables.

Table Name

Field Name

Data Type

Field Description

client

username

string

username of user

client

password

string

user password

client

user_id

int

user authentication

media

video

string

name of video file

media

picture

string

name of picture file

media

file

string

unique media id

1. Detailed System Design

This section provides low-level design descriptions that directly support construction of modules. Normally this section would be split into separate documents for different areas of the design.

Component 1 – Picture Uploader
Classification

Module

Definition

Gives the user the opportunity to upload a picture on the website.

Responsibilities

This is responsible for allowing the user upload a picture and save it at database and can be accessed whenever the user wants to.

Constraints

Not being able to upload or attach correctly to the users profile and recent documents.

Composition

There aren't any sub-components with this module.

Uses/Interactions

This module is used by the actual client, and it communicates with the server (and database).

Resources

Some of the resources used would include the media library and the database (to search for the desired media item or items).

Processing

There is a limit to the pictures uploaded by each user so it would be some sort of linear search to access and store the pictures.

Interface/Exports

The user uploads the picture and saves it. User can go to it whenever he/she wants to.

Component 2 – Video Uploader
Classification

Module

Definition

Gives the user the opportunity to upload a picture on the website.

Responsibilities

This is responsible for allowing the user upload a picture and save it at database and can be accessed whenever the user wants to.

Constraints

Not being able to upload or attach correctly to the users profile and recent documents.

Composition

There aren't any sub-components with this module.

Uses/Interactions

This module is used by the actual client, and it communicates with the server (and database).

Resources

Some of the resources used would include the media library and the database (to search for the desired media item or items).

Processing

There is a limit to the pictures uploaded by each user so it would be some sort of linear search to access and store the pictures.

Interface/Exports

The user uploads the picture and saves it. User can go to it whenever he/she wants to.

Component 3 – Batting Average Calculator
Classification

Function/Module

Definition

This will allow the user to calculate batting average accurately with out the use of a spreadsheet from Microsoft Excel. The user will have to input the number of hits and number of at bats then press calculate numbers and it will show the batting average that was calculated.

Responsibilities

One of the main functions of the project and can be accessed through a link in the webpage.

Constraints

Not give the accurate answer. User will not know how to work it.

Composition

Sub-components include a calculate button. After pressing it will show the results.

Uses/Interactions

There is really no interaction with any databases it just calculates batting average.

Processing

It will be used right from the user’s browser.

Interface/Exports

Interface will be accessed on a browser that meets these requirements.

Component 4 – Earned Run Average Calculator
Classification

Function/Module

Definition

This will allow the user to calculate the earned run average of a pitcher. User will input the number of scored runs and innings pitched then press calculate. After doing this the results will be displayed.

Responsibilities

One of the main functions of the project and can be accessed through a link in the webpage.

Constraints

Not give the accurate answer. User will not know how to work it.

Composition

Sub-components include a calculate button. After pressing it will show the results.

Uses/Interactions

There is really no interaction with any databases it just calculates earned run average.

Processing

It will be used right from the user’s browser.

Interface/Exports

Interface will be accessed on a browser that meets these requirements.

Component 5 – Managing User Content
Classification

Function

Definition

To help with the process of dealing with media files such as pictures or videos uploaded by the user.

Responsibilities

This function will be responsible for allowing the user to manage their content that has been uploaded (pictures and videos). It will be managed possibly through a linear search within the user’s database.

Constraints

Not building a good enough user interface. Not building a good content manager structure.

Composition

It will be shared with the picture and video uploader.

Uses/Interactions

Users will be able to view their images posted and videos as well. They can access this whenever they want to. Also they can remove them as well.

Resources

Resources used will be a View Pictures and Videos.

Processing

This will be only with the client. This will interact with the resources mentioned above. This will make the project work more efficiently and instead of each having their own function which would occupy more space functions will be shared.

Interface/Exports

The interface will be accessed on a browser that meets these requirements

scriptmafia.org

-- RicardoRodriguez - 2011-03-14

Topic revision: r4 - 2011-05-22 - RicardoRodriguez
 
This site is powered by the TWiki collaboration platformCopyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback