CERN Accelerating science

This website is no longer maintained. Its content may be obsolete. Please visit for current CERN information.

CERN home page CERN home page The Consult page The Consult page This page The Consult page This page This page Help, Info about this page

Previous: Previous Garfield Version 6.27 (See printing version)
Next: Next Software Development Tools Service

Software Documentation Layout Templates (SDLT) V1.0

  Mario Ruggier IT/IPT

Documents are produced in all phases and activities of a software development cycle, e.g. User Requirements, Design and Architecture, Configuration Management, Test Plan, Project Plan, and so on. The content material required by each of these different document types is very specific - in fact a detailed table of contents, as well as additional guidelines, are normally provided by the standard being followed, e.g. IEEE, ESA, ISO. However, it is generally desirable to have a consistency in the layout (formatting, style sheets, visual style) across all of the specification documents for a software development project.

The Software Documentation Layout Templates (SDLT), produced by IT/IPT, are a set of generic format templates to be used in conjunction with separate content-only templates, specific to each document type. A content-only template will therefore specify such things as the detailed table of contents, sample material and guidelines for the type of document. The advantages offered by this scheme are:

An example of such a content-only template is the new version of the ESA URD content template, which thus supersedes the last release of the CERN PSS-05 template, Version 2 of 30 June 1998.

The SDLT are produced for Adobe FrameMaker 5.5, thus usable on various UNIX, PCs and MACs. Features include:

The SDLT V1.0 package will be available on 15 January 1999. At this time, more information and access will be available from the templates section of the "FrameMaker at CERN" Web page at:

Anyone wishing to test these templates prior to the release date, please contact

For matters related to this article please contact the author.

Last Updated on December 15th, 1998 at 10:12:50
Copyright © CERN 1998 -- European Laboratory for Particle Physics