QMA_C_1017_detailed_concept_plant_software_EN

Project:	«ProjektProject»
Project number:	«ProjektnummerProjectnumber»	Project manager:	«ProjektleiterProjectManager»
Installation / Server ID:	«AnlageSite»
Customer:	«AuftraggeberCustomer»
Creator:
Control system version:

Distribution list:

Project Manager Project members

Change status:

No.	Date	Author	Brief description of the change/extension	Version
1	15.04.2020	Author xy	Draft created	1

ATTENTION:

Within the following, all explanatory texts in the template are printed in blue. These texts must be removed from the template before it is used for the project.

The above listed version number is intended to distinguish between the current status of the detailed concept. Each version of the detailed concept is stored in a separate backup file. This allows the change history to be traced clearly later on.

The title of the work package within the title, as well as in the footer, can be set in the Word menu item File - Properties in the "Title" parameter

The version number in the footer bar is also changed via the file properties in the "Keywords" parameter

Table of contents

1	General guidelines	3

1.1	Applicable guidelines and standards	3

1.2	Applicable documents	3

2	Task of the work package	3

2.1	General information	3

3	System environment	5

3.1	Introduction	5

3.1.1	Requirements	5

4	Subject area A	6

4.1	Introduction	6

4.2	Requirements	6

4.3	Subarea A	6

4.3.1	Requirements	6

4.4	Subarea B	6

4.4.1	Requirements	6

5	Presentation and approval of the detailed concept	7

General guidelines

Applicable guidelines and standards

The current programming guidelines of ProLeiT (QMA_A_0310_Programming Guidelines_Plant Software_EN) apply.

All applicable guidelines beyond this are also listed here. E.g. guidelines from the customer or guidelines for GMP projects etc.

Applicable documents

All documents that were used as a basis for the detailed design must be listed here. E.g. rough concept, specification sheet, requirement specification, meeting report with the customer, process descriptions from the customer etc.

File	Version	Creator

Task of the work package

General information

A detailed concept is a document with a detailed description of how the customer requirement is to be implemented and thus serves as a "programming template".

The detailed concept describes all instances in which data is stored, through which data is transferred, through which data is input or output. The detailed concept should NOT describe internal variables such as local loop counters, etc. The detailed concept does not have to, but can, if required, describe the program to be created in detail.

A work plan for the bricklayers may serve as a comparison. The work plan has been drawn up by the architect in such detail that a bricklayer who was not present at the planning stage is still able to build the house thanks to his expertise and the work plan.

Transferred to IT projects, this means that it must be possible at any time to pass on the actual execution of the work to an appropriately qualified person by means of the detailed concept.

The detailed concept must continue to be created in such a way that later, after the project has been completed, extensions can be introduced, or existing errors found with a minimum of time.

The degree of detail of the concept depends on the task at hand. It is necessary and important to describe all data structures and data flows. Whether complete program flow charts are also created should be made dependent on the complexity of the task.

If, on the other hand, you carry out recurring work, such as filling out a TF sequence, then you will usually be able to do without it.

Examples where one should ALWAYS create a program flow chart or a communication plan or a state plan:

Communication between two computers

Protocol drivers, e.g. for scales, displays, ....

Class handlers

Communication between a frontend and a database or PLC

Completed control programs such as modules for conveyor technology control

Sequences (clearly define steps and determine the transition conditions)

System environment

Introduction

Description of the system environment for the following work packages.

The following sketch shows the system environment for the workstation "Labeling at Goods Receipt".

Requirements

Description of the requirement in key points in tabular form for the respective chapter (e.g. scope of functions of interfaces, creation of test cases, ...)

Ok	Bug
1	There are several workstation PCs and label printers.	X
2	Each workstation PC must be equipped with a monitor, mouse and keyboard.	1
3	The workstation PC is installed by the customer ready for operation with Windows 10 and a functioning network connection. Network access to the Plant IT Server must be possible. PCs with Windows 7 can no longer be supported by the Plant IT control system.	X
4	Plant IT Operation Manager is installed and commissioned by ProLeiT.	2

Subject area A

Description (possibly graphical)

Introduction

Optional process description (tabular)

Requirements

Ok	Bug

Subarea A

Description

Requirements

Ok	Bug

Subarea B

Description

Requirements

Ok	Bug

Presentation and approval of the detailed concept

The detailed concept was presented to the following persons in final:

Project Manager

The detailed concept has been approved by:

Place, Date	Project Manager