PSS-05 User Requirements Document Template

Since 15 January 1999, this template package is replaced with the combination of the Software Documentation Layout Templates and the URD Content Template. Please use those instead.

"All my life, I've wanted to be somebody.
But I can see now, I should have been more specific."

-- A Lily Tomlin character, a bouncing aerobics instructor

In this page... The PSS-05 guidelines About the URD Template Some URD examples Template User Manual Distribution For more info or comments please contact DocSys.Support@cern.ch.

The PSS-05 guidelines The PSS-05 Software Engineering Standards (SES) developed at the European Space Agency (ESA) are intended as a set of guidelines for building good software. PSS-05 requires that a number of documents, covering the entire life cycle of a software project, are produced. To ensure completeness, each of these documents should follow a predefined structure. Documentation of these standards is collected in the 1994 publication from Prentice Hall, Software Engineering Standards (ISBN 0-13-106568-8), of which we have a few copies in the IPT Group library. The PSS-05 standards are currently under review, due to the paradigm shift brought about by OO. As a whole PSS-05 are obsolete for OO, except for the UR phase, the single most important output of which is the URD. User requirements are one of the first areas that must be addressed when embarking on SPI (Software Process Improvement) and is a key process area of level 2 of CMM (Capability Maturity Model) as defined by SEI (Software Engineering Institute). About the URD Template The goal of the FrameMaker URD template is to ease the production of a PSS-05 conformant User Requirements Document. The template contains the predefined sections as specified by PSS-05, as well as a comprehensive set of predefined formats. Using FrameMaker, a high quality printed version and a WWW version can be automatically derived. An ASCII version of is also included for convenience. Copyright Statement The templates are Copyright © CERN 1995. Some URD examples ATLAS DAQ Back-end software ATLAS ROB CMS Gas Control System for the MSGC B1 milestone CMS CARDS Gas Control System for the MSGC B1 milestone PS Automated Beam Steering / Shaping Support Services for Windows NT at CERN Template User Manual Available in the following formats: Online Web format. TUM.pdf, contained in the distribution (CERN only). Printed hard copy, available from the IPT offices in building 1 at CERN. CERN Only Distribution (Version 2, 30 June 1998) HISTORY Cumulative release notes. PSS05Tv2.tar (2.1 Mb) The full distribution package, including PDF manual. You do not need to download this if you are on UNIX and use the full installation maintained by the SDT Service. Please see Pre-installation on UNIX at CERN, below. Once you have established access to the SDT template installation, you only need to download a copy of the URD instance tar file, as described below. URD_Instance.tar (0.8 Mb) Instance tar file (part of the full distribution package) containing an instance of a User Requirements Document. To be used for creating new instances of a URD; can be moved around, copied and edited independently from full installation of the URD Template. Once you download you can unpack either of these archive files with WinZip (Windows), Expander (Macintosh) or, for UNIX systems, with a command such as: tar xvf PSS05Tv2.tar For further instructions read the included README files and the Template User Manual. Pre-installation on UNIX at CERN CERN UNIX machines can also access the installation of the templates that is maintained by the Software Developments Tools Service (SDTS) under the directory: /pttools/Templates/FrameMaker/PSS05/ To access this installation you will need to: NFS: mount pttools:/pttools/Templates under /pttools/Templates AFS: soft link /pttools/Templates to /afs/cern.ch/pttools/Templates

Copyright © CERN 1995