Guidance and format for writing an “Operation Manual” (aka “User’s Manual” or “Operator’s Manual”)

Document #:

LIGO-M1200366-v2

Document type:

M - Management or Policy

Abstract:

The main document provides guidance for writing an “Operation Manual” (aka “User’s Manual” or “Operator’s Manual”).
There is a supporting document which is a template file for an E-type Operation Manual.
Also included is a snap-shot list of the manuals in the DCC as of 9-18-2012

N.B.: Future manuals must comply. Previously written manuals do not need to be re-written.

Files in Document:

• M1200366-v2 Guidance for writing an Operation Manual.pdf (file is not accessible)

Other Files:

• M1200366-v2 Guidance for writing an Operation Manual.docx (file is not accessible)
• Operation Manual Template (supporting file for M12003...docx (file is not accessible)
• operation manuals in DCC - snapshot 9-18-2012.xlsx (file is not accessible)

Topics:

• System Engineering
• Policies

Authors:

• Dennis Coyne

Notes and Changes:

Added a note in the guidance document, as well as in the manual template, to include, under the "maintenance" section, a list of needed operational spare parts and to include a schedule of maintenance operations and/or inspections and needed frequency.

Referenced by:

• LIGO-M1100282-v2: Acceptance Deliverables and Criteria for Advanced LIGO
• LIGO-E1200633-v2: aLIGO SUS Operations Manual
• LIGO-E010613-v2: Generic Requirements & Standards for Detector Subsystems