Constructor templates

 

Key principles

  • Proformas are an aid
  • Constructors cannot depart from templates, hence the information that needs to be provided by constructors has to be clarified in the main text
  • Proformas need to be uniquely identifiable
  • The publication route for constructor proformas / templates will be that they can be added as part of the publication process as ‘additional’ documents
  • The proformas will be available on the SfH website alongside the associated core document.
  • Proformas will be introduced with a standardise approach so the user can associate proforma with the relevant clause
  • There are no plans for automated referencing within the document; this will need to be manually managed.
  • Version number of the proforma needs to be aligned with the document
Back to top

How to introduce a constructor template in the SHW / standard text to be used?

Please distinguish between one off documentation and continuous records.

One off documentation

Example:
1.1 The following Documentation shall be submitted for <vehicle recovery logging> prior to the commencement of <operations>: Vehicle Recovery proforma [add name of proforma]
1.2 The requirements for Documentation [replacement for clause 104 and 105] shall apply to <vehicle recovery logging>.
1.3 The following information shall be logged into the < Vehicle Recovery proforma>:

  • 1) date
  • 2) location
  • 3) etc.
Back to top

Continuous record

Example:

1.1 The following Documentation shall be submitted for <vehicle recovery logging> as a continuous record: Vehicle Recovery proforma [add name of proforma]
1.2 The requirements of continuous records [replacement for 105] shall apply to <vehicle recovery logging>.
1.3 The following information shall be logged into the <Vehicle Recovery proforma>:

  • 1) date
  • 2) location
  • 3) etc.
Back to top

Should the constructor proforma be duplicated in the SHW or only given in the proforma provided on the website?

No, constructor proformas are not reproduced in the SHW, they are only given on the website. However, the information to be provided is to be listed in the main text, see examples above.

Back to top

What is the format of the constructor proforma?

Open format file (excel style)

Back to top

Proforma name

Proforma name for the requirement in the SHW text:
Vehicle recovery proforma for x
Vehicle recovery proforma 1
Proforma file name for the website (includes document code and version number):
Vehicle recovery proforma for x – CC 130 v1.1.0
Vehicle recovery proforma 1 – CC 130 v1.1.0

Back to top

Version number

Version numbers of the proforma and of the related document will be the same:
CC 130 v1.0.0
<Subject> proforma – CC 130 v1.0.0

This principle applies even when one of the two changes, e.g.:
• If the proforma changes, document version number changes too:
CC 130 v1.1.0
<Subject> proforma v1.1.0
Vehicle recovery proforma – CC 130 v1.1.0

• If the document changes but not the proforma, the version number of the proforma will be updated too.

Back to top