Requirements Document Template for
Systems and Components, Software and
Hardware
The template for writing Requirements documents is available in FrameMaker
RequirementsTemplate.fm (for FrameMaker V6), RequirementsTemplate.mif (i.e.for older versions of
FrameMaker) and for easy viewing and printing in pdf format RequirementsTemplate.pdf. It has been converted to Word
requirements_template_Word.dot. FT has produced a version in
Staroffice5.2: RequirementsTemplateStaroffice5.2.vor
When using it, please read the guidelines and examples from the above listed PDF
file, as they are not contained in the STARoffice template. A tar file for the
version in Latex RequirementsTemplateLatex.tar.gz
has been made available by AA,
a README file is included. Conversions to other document
formats are not foreseen but we will make those available here which we get
provided with.
The Template is based on the requirements template from CERN/SDT. It has been slightly
simplified and contains additional explanatory text tailored to the needs of the
TDAQ/DCS community. Your feedback is welcome!
Architecture and Design Document Template
In general we refer to the Rational Unified Process (RUP) template for architecture and design documents. An adaptation of this template for Atlas TDAQ in FrameMaker and the same in Word format ArchitectureDesignTemplate_Word.dot is available. It proposes the same chapters and sections and the same diagram views but includes specific explanations. Examples are provided by the RUP. If you are accessing this page from a Cern machine, it is recommended to view the guidelines directly from the RUP to be able to profit form the hyperlinks which are available inside the RUP. A local copy without valid hyperlinks has been made available for remote collaborators. An Atlas TDAQ document is available as a recommended example and can be obtained via e-mail. Recipes for the diagram production and for including them into a document have been prepared.
Local copy of the selected RUP templates and examples Use of these documents is permitted for work in context with CERN
Template for Software Architecture Document in Word
Template for Software Architecture Document in FrameMaker
(zip file for a book)
Examples Course Registration
System and Collegiate
Sports Paging System (no hyperlinks available)
Concepts for Architectural Analysis and Design Concepts
(no hyperlinks available)
Guidelines Guidelines for Software Architecture
and Design Document (no hyperlinks available)
How to access the relevant documents in the RUP
Access from a CERN machine: http://sdt.cern.ch/RUP/ You can find very good and concise introductory overview material prepared by the SDT group there under 'Documentation'. To access directly the selected documents via the RUP, choose 'Any platform', then 'Overview'
To view the guidelines and for general information choose from
the left side menu from 'Overview'
-> Disciplines
-> Analysis & Design
-> Concepts
-> Software Architecture
On this page you will find : Guidelines
To access the template and examples for the template directly choose
from 'Overview'
-> templates
-> HTML
choose under
the heading 'Analysis & Design' from this page the Software Architecture
Document
On the following artifact page you can find the Template and two
Example documents on the Course Registration System and the Collegiate Sports Paging System.
Hyperlinks will guide you through concept descriptions and explanations.
Test Plan and Test Report Templates
Template for a test plan in FrameMaker TestPlanTemplate.fm
in Word TestPlanTemplate.dot
with its PDF version TestPlanTemplate.pdf
Template for the test report in FrameMaker TestReportTemplate.fm
tin Word TestReportTemplate.dot
with its PDF version TestReportTemplate.pdf
The templates provide the document structure and contain comments on the suggested content in the various sub-chapters. More hints and guidelines can be found on the Testing page under 'SDP'.
General Document Templates
A template for short notes has been prepared following the
format and style of the other document templates proposed by the Atlas Connect
Forum: in Frammaker: ShortNoteTemplate.fm
ShortNoteTemplate.pdf
and in Word: ShortNoteTemplate.dot
For general document templates see the Cern STD web page.