Template for implementation documents

Marc Groenewegen (marcg@dinkum.nl)

May 5 2003

Document Information
Organisation Hogeschool voor de Kunsten Utrecht (HKU)
Project name Signature
Version 0.1
Status draft
Location mediate/signature/doc/db_implement.xml
Audience Gerard van Wolferen, Hans Timmermans
Abstract:
The abstract gives a short description of the contents of this document. This document describes the implementation of the Signature database using a linked list structure and other things that might be relevant to the design, although these have to be defined as such and must be more than just text to fill the page, like this piece does.

Table Of Contents

1 Introduction

2 List of definitions

3 General description

4 Detailed description

5 Implementation environment


1 Introduction

The actual implementation of a system is the collection of code, hardware, choice of programming language etc. The implementation document may contain any information relevant to the implementation, even fragments of code.

Keep the focus on the system as it is (or will be) built. In the design document we describe possible alternatives and choices but in this section we only describe the solutions that were chosen to be implemented and these deserve to be described accurately enough for another designer to do the implementation work.

The implementation document is also very useful for debugging and maintenance purposes, so every minor detail has to be described in it.

1.1 General remarks

1.2 Purpose

Describe the purpose of this document (not of the system we're designing) and the intended audience.

1.3 Scope

Describe project constraints and parts that are deliberately NOT described.

2 List of definitions

Explain all terms, abbreviations and information that can be considered unknown to the reader.

3 General description

3.1 System overview

Give an overview without too much detail of the system that is described in this document.

3.2 Context

Give a short description of the context in which the (sub)system is placed and how it relates to other (sub)systems.

4 Detailed description

Describe all details that are necessary for understanding the entire implementation. Organise the information into functional sections.

4.1 Hardware

Describe the hardware components in detail

4.2 Software

Describe the software components in detail

4.3 The world outside

Describe communication with other systems and what network, protocols and physical connections are used. This can go as deep as specifying protocol bits, socket connections etc.

4.4 System integrity and error handling

Describe the error handling mechanisms that are implemented.

5 Implementation environment

This chapter lists the tools and resources used for the implementation.

5.1 Implementation tools

List all implementation tools, software packages, programming languages etc. used in the implementation and which purpose they serve.