1 Document Description

This chapter provides information about this document to the reader and will also provide help to anyone who changes the document.

1.1 Purpose

The purpose of the architecture specification is to provide an overview of the system PUM-group 3 is developing, a document generation module named ArgoPrint, for ArgoUML. The document describes and motivates important architectural decisions, made during the first steps of the design work, and works as a link from the requirements to the detailed design. The latter will be described in the design specification [Sidebäck, 2003].

1.2 Document overview

The architecture specification is divided into the chapters described below.

1. Document Description

Describes the document structure and content.

2. System Overview

Gives a brief description of the customer of the ArgoPrint and how the system is supposed to work.

3. Use-Cases

Describes the usage of the system

4. Architectural Design Decisions

Describes important design decisions made during the architectural design and how these correspond to the behavior of the system.

5. Design Method

Describes the method used to describe the architectural design of the system.

6. Architecture Description

Description of the architectural design developed using the design method described in chapter 5.

7. Reflections of Requirements

Describes where the requirements in the requirements specification can be found in the architecture of the system.

8. References

1.3 Reading suggestions

The reader should be familiar with the expressions and abbreviations in chapter 1.6, Glossary. To better understand the requirements on the system, the requirements specification should also be available to the reader.

To get a good overview of what the project is all about, read chapter 2. If the reader wants a more detailed description of the system and it's architectural design, the whole document should be read.

If the reader aims to change the design of the system or desires a more detailed design, for example to be able to implement the system, the design specification is recommended.

1.4 Document dependencies

1.4.1 Documents which affect the architecture

Requirements Specification [Engström, 2003]

The architectural design is developed with consideration of the requirements specified in the requirements specification.

Projektplan [Gröndahl, 2003]

Changes in the project plan may affect the architectural design.

1.4.2 Documents which the architecture affects

Design Specification [Sidebäck, 2003]

Every change in the architecture of the system will cause changes in the more detailed design.

Webdoc [Danielsson 1, 2003]

Changes in the design will cause changes in the implementation and therefor also in the documentation of the same.

User Manual [Danielsson 2, 2003]

Changes in the architecture may cause changes in how the system will be used.

Test Document [Albertsson, 2003]

Changes in the architecture may cause changes in how testing of the different modules of the system will be performed.

Requirements Specification [Engström, 2003]

If a requirement is impossible to design for, the requirements may have to be renegotiated and the requirements specification correspondingly changed.

1.5 Distribution

The document will be distributed as follows.

Examiners of this document, Erik Berglund and Hans Olsén.

Project Supervisor, Stina Edelfeldt.

The customer.

The project folder.

1.6 Glossary

One should be familiar with the following abbreviations and expressions in order to fully understand the architecture specification.

Base-lining To make sure that a release includes the correct version of all files. This is done by checking that the intended functionality is implemented in the included versions. At this time reports are written that describes the system's capabilities.
ArgoPrint will be used to generate these reports from the UML-model in ArgoUML.

CM Configuration Manager, a description is available in chapter 2.5.

DA Document Author, a description is available is chapter 2.5.

DocBook A format that is used to describe the structure of a document. DocBook files are written in XML.

HTML HyperText Markup Language, the coding of ordinary web pages.

Java VM Java Virtual Machine, the program that executes the Java code.

JDK Java Development Kit, a package of files that includes a compiler so that you can build your own Java programs.

JRE Java Runtime Engine, a package of files that includes the Java VM and the standard libraries so that you can run a Java program.

OO Object Orientation.

OOA Object Oriented Analysis.

OOD Object Oriented Design.

OOP Object Oriented Programming.

PDF Portable Document Format, from Adobe. Can be viewed with the free Acrobat Reader from Adobe.

UML Unified Modelling Language, a standard for modelling object oriented systems.

XML eXtensible Markup Language, a language that specifies the semantics of a string, so that it can be interpreted by another program.

Quadralay Corporation http://www.webworks.com Voice: (512) 719-3399 Fax: (512) 719-3606 sales@webworks.com