Preface to CMS Software Documentation

Complete:

Contacts

• Conveners: Kati Lassila-Perini
• Editors:
  • WorkBook, Offline Guide: Jenny Williams, Kati Lassila-Perini
  • Reference Manual: tbn
• Hypernews forum:
  • WorkBook: https://hypernews.cern.ch/HyperNews/CMS/get/workbook.html
  • General user support organization: https://hypernews.cern.ch/HyperNews/CMS/get/supFeedback.html

Introduction

This documents gives an overview of the CMS Software documentation. It is based on the CMS Software documentation policy which defines the general structure of the CMS Software documentation, and the different actors and their responsibilities in the documentation and its maintenance.

CMSSW documentation suite

The CMSSW documentation consists of three main elements:

• the CMS Offline WorkBook
• the CMS Offline SW Guide and
• the CMSSW Reference Manual.

The WorkBook contains the instructions on accessing computing resources and using the software to perform analysis within the CMS collaboration.

The Offline SW Guide gives full details of CMS Software including description of algorithms and software architecture, instructions for analysis and validation and common items such as developers’ guide, trouble shooting guide, FAQ lists, and instructions for code optimization.

The Reference Manual contains the release dependent technical documentation such as class lists, brief description of content and purpose of each package and default configuration files and sequences.

How to use the documentation

Using the WorkBook page explains how to get the most out of the WorkBook. The reader will learn what the various symbols and links on the workbook pages mean, what type of information they link to, who to contact about a given page, and how to provide feedback to the editors. A similar page should be provided for the Offline Guide.

A brief introduction to the Reference Manual use is given in WorkBookHelp#RefMan.

Review status

Reviewer/Editor and Date (copy from screen)	Comments
KatiLassilaPerini - 22 Oct 2007	created page

Responsible: KatiLassilaPerini
Last reviewed by: Most recent reviewer