<sub-group><component>10Draft | FinalATLAS-TDAQ-2003-XXX or EDMS Id XXXXXXLast modification dateCERN

ATLAS TDAQ <sub-group>

<component> Test Report

Document Version:	1

Document Issue:	0

Document ID:	ATLAS-TDAQ-2003-XXX or EDMS Id XXXXXX

Document Date:	Last modification date

Document Status:	Draft | Final

Abstract

Abstract text

This is a template to report on unit, component or integration tests.

Keywords: list of keywords

Institutes and Authors:

Institute 1: A. Author, B. Author, C. Author

Institute 2: A. Author

Institute 3: A. Author, B. Author

etc…

Table 1 Document Change Record

Title:	ATLAS TDAQ <sub-group> <component> Test Report
ID:	ATLAS-TDAQ-2003-XXX or EDMS Id XXXXXX
Version	Issue	Date	Comment
1	0	Last modification date	Do not forget to change the document details by clicking the ‘Document Details’ button in the menu.
A different version number should be given to the document if substantive changes to the contents of the document have been made. Different issue numbers within a given version indicate minor changes only such as spelling and grammatical corrections.

Note on red text: The red text provides an explanation of the suggested contents for each section and some examples. In the MS Word template, the red text is defined with the style “Description Text”.

Introduction

Brief introductory text about the component test.

Purpose of the document

This document presents the Test Report for the <component> of the ATLAS TDAQ <sub-group>. If there is no Test Plan (or if this will not be archived) you should include a Chapter “General Description” and “Approach” for completeness. This will not be necessary if the Test Plan is archived. In which case it should be referenced here.

Glossary, acronyms and abbreviations

Provide definitions for all terms, acronyms and abbreviations used in this document. Any existing glossaries which are used should be referenced, to avoid repetition here.

Glossary

For long descriptions use a pair of Dfn1Part1Term/Dfn1Part2Desc paragraph formats.

Example: Farm

A set of computing node linked by a network or bus

Something else to be defined

And here is the description for something else

A reference to the ATLAS/TDAQ glossary may be sufficient (http://mdobson.home.cern.ch/mdobson/tdaq/glossary.html)

Acronyms and Abbreviations

For short descriptions use a pair of Dfn1Part1TermR1H/Dfn1Part2Desc paragraph formats:

CERN	European Laboratory for Particle Physics

ASA	Another Silly Acronym

References

List all external documents referenced in this document

1

2

3

4

5

General Description

Short general description of the test and the component under test with appropriate references. Explain context, background, purpose and assumptions.

Add appropriate subsections only if the general description needs to be broken down for clarity. This should not be necessary if the chapter is sufficiently short.

The material could be copied from the Test Plan if a reference to the Test Plan is undesirable.

Test Features and Items

List the features and items that were tested or did not get tested for some reason, perhaps with an explanation. This could be an annotated copy of the features and list of items in the Test Plan.

Approach

Describe the test programs (or provide a reference) and approach: how and the expected outcome.

Analysis Tools

Mention the analysis tools (for example Excel, scripts) that were used and give a brief description and reference to the tools if necessary.

Results

Describe the results of the test, measurements and subsequent analysis. This may be broken down in subsections if required. For simple tests, the list given in “Test Items and Features” may be sufficient. Provide a reference to detailed results that are archived.

Assessment

Provide a critical assessment of the experience (‘lessons learned’), approach, organisation, logistics, responsibilities, schedule and availability of resources.

Conclusions

Experience and conclusion: what was the main important outcome, were expectations satisfied, which new effects were found, what are the possible explanations and consequences, are follow-up tests foreseen and why.

Acknowledgements

Non authors of the report who have made contributions that you wish to acknowledge.

Appendix

Everything which does not directly belong to the Test Report but is useful as back-ground information, more detailed results, results obtained in previous tests useful for comparison…

This document has been prepared using the Test Report Document Template version 0.2 provided and approved by the ATLAS TDAQ and DCS Connect Forum. For more information, go to

http://atlas-connect-forum.web.cern.ch/Atlas-connect-forum/.

This template is based on the SDLT Single File Template that has been prepared by the IPT Group (Information, Process and Technology), IT Division, CERN (The European Laboratory for Particle Physics) and then converted to MS Word. For more information, go to http://framemaker.cern.ch/.

ATLAS

page 4	Draft | Final

ATLAS TDAQ <sub-group> <component> Test Report

Draft | Final	page 1

ATLAS TDAQ <sub-group>	<component> Test Report

Version/Issue: 1/0

<component> Test Report	ATLAS TDAQ <sub-group>

Report Template

SEA

2002-05-23

Jim Cook

SEA