Operations Manual Template Specifications
Operations Manual Template Specifications
Operations Manual Template Specifications
1.1 Scope
The Main Contractor shall provide an Operation Manual covering the work of the Civil
Contract and all Nominated Sub contracts. Operation Manual shall also be provided by the
various equipment suppliers and Nominated Sub-Contractors for integration into the Main
Contractor’s manual.
1.2 General
The Operation Manual shall be an essential part of the equipment supplied under this
Contract. The supply and delivery of equipment will be regarded as incomplete until the draft
Operation Manual is submitted and approved. Draft Operation Manual with the content
specified shall be submitted in the format specified by Goulburn Valley Water (GVW). GVW
has developed Operation Manual templates for use by the Main Contractor, Nominated
Subcontractors and equipment suppliers.
1.2.1 Definitions:
The term contractor shall be read as meaning the Main Contractor, unless specifically noted
otherwise throughout this section of the Specification.
1.2.2.1 Within 21 days prior to the commencement of commissioning of the Works the
Contractor shall provide to the Superintendent for approval, one (1) digital copy
of the draft Operation Manual for all items, or groups of similar items of
equipment supplied under the Contract.
1.2.2.2 The Contractor shall also amend existing Operation Manual instructions where
the Contract works impact on existing plant operations.
1.2.2.3 The manual shall be specific to equipment being supplied. Supplier equipment
manuals, Catalogues, sales brochures and other documents giving general
information will not be acceptable alone as Operation Manual.
1.2.3.2 The digital Operation Manual shall be formulated according to the requirements
of GVW’s Operation Manual Writing Guide.
When the draft manual has been accepted by the Superintendent, the Main Contractor shall
submit to the Superintendent, within one (1) calendar month of receipt of the
Superintendent’s acceptance of the draft, one (1) fully indexed Hard Copy of the Operation
Manual and one (1) complete Digital version of the Operation Manual. The Digital version
should include associated supplier equipment manuals, drawings and any additional
attachments which may compose of more than one (1) Compact Disc.
1.3 Format
1.3.1 General
The Digital and Hard Copy Operation Manual for process element operating instructions shall
be formulated to the above mentioned Writing Guide requirements using GVW’s Operation
Manual Writing Guide and the supplied Microsoft Word templates:
a) Contractor Template for Operation Manual
b) Contractor Template for Maintenance Requirements
1.4 Content
1.4.1 General
Operational descriptions are to be captured in the blank Microsoft Word Contractor Template
for Operation Manual as provided by GVW.
Instructions have been included on the template in red font. Instructions in red font shall be
deleted as the template is populated. Three different process element sections have been
supplied and these sections may be duplicated if more process element information is to be
included.
The completed template can then be printed and used as the Contractor’s Hard Copy Manual
for the Process Element description. All other mentioned requirements listed in the
Specification that are to be produced and supplied for the digital manuals, are to use the
relevant applications from the Microsoft Suite of Office Products.
(vii) List of individual items of equipment which are components of, or are
associated with, the equipment described in this sub-clause of the
Specification.
(viii) Reference Drawing List.
(ix) All other information necessary to fully specify the item of equipment.
(x) Equipment supplier’s name, address and telephone number.
c) Operating instructions and description of the equipment and its principles of
operation including:
(i) Theory of Operation.
(ii) Function of Equipment.
(iii) Pre-Start-Up Checks and Adjustments.
(iv) Start-Up Procedures.
(v) Normal Operating Modes (i.e. Pump Selector Switch to AUTO), including
references to the SCADA screen images provided by GVW.
(vi) Normal Shut-Down Procedures.
(vii) Process Controls.
(viii) Emergency Start-Up and Shut-Down Procedures.
(ix) Visual checks and observations that should be made routinely to ensure
equipment is operating satisfactorily.
(x) Diagnostic troubleshooting techniques, where applicable, to determine
probable causes of operating difficulties or alarm situations.
d) Maintenance instructions in tables provided in template showing:
(i) Recommended preventative maintenance procedures, tests and activities
to ensure that equipment and components are adequately maintained.
(ii) Frequency that each preventative maintenance procedure should be
carried out.
(iii) Lubrication points and recommended lubricants.
(iv) Details of any special tools, lubricants or cleaning agents necessary to
implement the preventative maintenance procedures.
e) Dismantling instructions:
Dismantling instructions shall include step-by-step procedures to extract, fully
dismantle, re-assemble and re-install the equipment. The instructions shall
include checks, tests, tolerances on fitting and lining up components of the
equipment and all procedures to re-install the equipment correctly. The
instructions shall be supplemented by exploded view, drawings or photographs.
f) Spare parts lists with cross reference to sectional drawing shall include:
(i) Part Name.
(ii) Part Number (identification for ordering of spares).
(iii) Number of parts required.
(iv) Material of Construction.
(v) Availability.
(vi) Supplier.
g) Illustrations and drawings and shall NOT be limited to the drawings required to
be submitted under other clauses of the Specification and shall include:
(i) General arrangements.
(ii) Sectional arrangements in sufficient detail to allow all components to be
identified, all tolerances, clearances and fits necessary for the equipment,
dismantling, and re-assembly of equipment components shall be shown.
(iii) Any other drawings necessary for complete understanding of installation,
operating and maintenance of the particular item of equipment, including
3D format.
(iv) Subdivision drawings
h) Function, application, specification, and comprehensive technical data of all
equipment including sub-assemblies, proprietary items, and system circuit and
schematic diagrams thereof where applicable.
i) Troubleshooting.
j) Lists of spare parts recommended to be held in stock.
k) Procedure of ordering spare parts.
1.4.1.2 The manual shall contain clear and comprehensive illustrations and/or drawings
with all parts readily identifiable.
1.4.1.3 The Contractor may provide this information for review and comment by the
Superintendent prior to the final submission.
1.4.1.4 After the completion of Commissioning, the Contractor shall supply one (1) fully
indexed Hard Copy of the Operation Manual and one (1) digital copy on compact
disk to the Superintendent, including any amendments to the information
previously supplied which may have become necessary in light of the
commissioning process.
1.4.1.5 The Contractor shall not be entitled to a Certificate of Practical Completion until
all required Process Elements of the Operation Manual have been submitted to,
and accepted by, the Superintendent.