HTS 2001- Design Documents Presentation Prepared by: Jenifer Kaschak, Carey Thomas, and Tariq Khan
Proposal Review Requirements Analysis Reference Documents CLSA Diagram Class Diagram Sequence Diagram Use Cases Interface Example Design Document Topics
Proposal- Original Diagram Client Access Content Teach VB Diagnose Student Record DB Student Resources VB Teach
Web based tutoring system Hierarchical approach Home access for students Communication more important than content Visual Basic / ASP / Microsoft Access approach Key Requirements Analysis Points
Existing Internet-based tutoring systems www.smarthinking.com www.learnonline.com Technical Reference Documents www.wrox.com (Textbook website) www.rational.com (UML resource center Reference Documents
Class Diagram Description • · CobjClient – communicates with the server to receive necessary tutoring information; parses the array of information supplied by the server to provide specific help to the user; allows editing • · CobjServer – opens up a database and creates a new database object; creates a new user connection for every new user that signs on • · CobjDatabase – a simple database object; sets the name and record source • · CobjBrokenRules – checks for broken business rules that will hinder the program’s performance • - CobjUserConnection – holds all the characteristics of a user (ex. IP address, username, activities); sends messages to the user
CobjDatabase - DbName - RecSource - Fetch( ) - Save( ) - DeleteObject( ) CobjServer - OpenedDb - DbOpened - AUser - CountUsers - IsListening - UserName - ConnectedSince - LastActivityTime - UserIP - SocketTag - NewDatabase( ) - NewUser( ) - TerminateAll( ) - Broadcast( ) - StartListen( ) - StopListen( ) - ClassInitialize( ) CobjClient - IsValid - IsNew - IsDirty - IsDeleted - Load( ) - BeginEdit( ) - CancelEdit( ) - ApplyEdit( ) - Delete( ) - Valid( ) - ErrorCheck( ) - Send( ) - ParseArray( ) - SignIn( ) - SignOut( ) - ReceiveData( ) CLASS DIAGRAM ACCESSES 1 1 1 INTERACTS WITH 1 1 1 CONTAINS MANY CONTAINS CobjUserConnection - UserName - ConnectedSince - LastActivityTime - UserIP - SocketTag - Terminate( ) - Send( ) 1 CobjBrokenRules - Count - ClassInitialize( ) - RuleBroken( )
Use Cases - #1 Use Case 1: User logins into system Goal: To have the user login into the home tutoring system and begin using the program. Preconditions: User should know how to type into a text box and also should know the URL of the home tutoring system. Success End Condition: User is logged into the system. Failed End Condition: User is unable to log in and use the system. A failed login page appears. Primary Actor: User and computer Trigger: Login screen is the first screen to appear Description: 1. User enters in URL for the home tutoring system. 2. The login screen is the first screen that appears. 3. User reads the instructions. 4. After reading the instructions, user enters in the correct login information. 5. User then clicks on the login button.
Use Case - #2 Use Case 2: User asks a question and views the answers. Goal: To have the user ask a question to the system so that they can find a topic related to their question. Preconditions: Users should have logged into the system Success End Condition: User is able to view a topic pertaining to the question they asked. Failed End Condition: User gets an error message-prompting him or her for a question. Primary Actor: User and computer Trigger: User has logged into system Description: 1. User reads the instructions at the top of the screen. 2. User enters a question into the proper text box. User presses the submit button. 2. A list of topics appears on the left side of the screen under the select topics table 3. The user selects the topic most relevant to the question they asked. 4. User clicks on the topic. 5. The text of the topic appears in the topics table. 6. User can read through the topic and select other topics too.
Use Case - #3 Use Case 3: User views topics. Goal: To have the user select a topic of interest and display it. Preconditions: User should have logged into the system. Success End Condition: User is able to view a topic of their choice. Failed End Condition: No topic appears on the screen. Primary Actor: User and computer Trigger: User is logged into the system. Description: 1. User reads instructions at top of the screen. 2. User expands out the hierarchical tree containing a list of topics 3. User searches for the topic they are most interested in. 4. User clicks on the topic. The topic appears then on the right side of the screen under the topics table.