Authors (name, student id number or social security, email), date
30.1.2006
service X
analysis document
Version history
Table of Contents
1. Introduction 3
2. Use Cases 3
2.1. Use Case diagram 3
2.2. Use Case descriptions 3
2.2.1. Use Case 1: The first use case 3
3. Requirements 4
3.1. Technical Requirements 4
3.2. Functional Requirements 4
4. Architectural analysis 4
4.1. System overview 4
4.2. Analysis object model 4
5. User Interface Specification 5
5.1. UI Dialogue diagram 5
5.2. UI Tasks 5
5.2.1. Task list 5
5.2.2. Task specifications 5
6. References 6
Table 1. Global Definitions
Name / DescriptionSome term / Description of the term that needs an explanation
1. Introduction
This document should be started only after the topic has been accepted by the assistant of the course. This chapter introduces the selected service. The chapter also provides the results of the survey of technologies with reasoning for the technology selections.
2. Use Cases
2.1. Use Case diagram
This chapter contains the use case diagram(s) for the service. All the diagrams must be presented as UML which can be drawn with e.g. Prosa, Visio, Rhapsody or Rational Rose.
Figure 1. A sample Use Case diagram
2.2. Use Case descriptions
2.2.1. Use Case 1: The first use case
Actors: Add the actors here (such as User John)
Preconditions: List the preconditions here
Description: Describe the use case here. All the use cases should have value to the actor(s) as such, e.g. accomplish some meaningful task. E.g. John does something and the service starts (Exception [1]). John can then search his calendar and find the information he was looking for.
Optional: List possible optional things here
Exceptions: [1] Describe the possible exception here.
Post-conditions: John has accomplished something useful to him with the service.
3. Requirements
Presents the list of requirements for the system. Technical requirements present the requirements for the hardware/software platform, whereas the functional requirements define the requirements for the developed software.
Priorities:
1=must implement
2=should implement (time allowing)
3=be nice to have
3.1. Technical Requirements
Table 2. Technical Requirements
#No / Description / Priority1.1 / The first technical requirement / 1
3.2. Functional Requirements
Table 3. Functional Requirements
#No / Description / Referred Use Cases / Priority1.1 / The first functional requirement / 1 / 1
4. Architectural analysis
Architectural analysis gives reader a system overview at one glance.
4.1. System overview
Presents the overall structure of the developed software, e.g. different layers of the software and interfaces to the environment. Group can select the chart type that presents the system with the most descriptive way.
4.2. Analysis object model
This chapter presents the initial classes and their relations between each other and the actors. Analysis object model is derived from the use cases.
Figure 2. A sample Analysis Object diagram
5. User Interface Specification
5.1. UI Dialogue diagram
This chapter presents how the user accesses functionality through different views of the software.
Figure 3. A sample Dialogue diagram
5.2. UI Tasks
Presents the GUI task list and explains how the tasks can be performed with the specified user interface.
Figure 4. Relations between use cases/scenarios and GUI tasks
5.2.1. Task list
A sample task list:
- Select employee or visitor
- Set pin-code and cell phone number
- Set employee user-id, password and phone number
- Show the success of setting employee / visitor data
5.2.2. Task specifications
A sample task specification:
Task #1: Select employee or visitor
The user has opened a web browser and entered to the registration service main page. The service asks to choose an employee or visitor link. User clicks the visitor or employee link. The system opens a new web page. User can close the web application if he chooses to.
6. References
[1] A reference that provides some information related to the service or the software analysis.
2 (6)
[1] First author’s name with email address