Document control · Lesson 6 · Approx. 7 minutes including practice
Controlled templates
Templates standardise metadata, headings and presentation. They do not establish technical correctness. Control the template version and test that project-specific fields are updated when it is reused.
Step 1: Template baseline
A documentation workflow, not an equipment operating sequence. Animation starts only when you choose Play.
Use templates as a controlled starting point
A template should make required information visible without encouraging people to copy unverified technical content. Separate standard headings and metadata from project-specific requirements. Give the template its own identifier, version and owner. Explain which fields are mandatory and which sections may be omitted. Avoid including sample values that could be mistaken for approved limits, material grades or inspection criteria. Where examples are useful, label them unmistakably and remove them before issuing project documents.
Prepare and check the work
Test a template using two different products and a deliberately incomplete brief. Check whether it exposes missing equipment identity, revision information, source references and approval responsibilities. Use styles rather than manual formatting so the contents list and PDF bookmarks remain reliable. Confirm headers, footers, table breaks and landscape pages after export. When the template changes, decide whether existing documents require migration; a template update alone does not authorise changes to technical content.
Worked example · demonstration only
A new manual inherits another customer’s name in a footer and an obsolete contact number in an appendix. Treat both as template-control failures. Search all fields and properties, fix the source template and recheck the project output. A polished cover does not compensate for inherited incorrect details.
Guided practice and review evidence
Use only a demonstration dataset for this exercise: Create a title-page checklist for equipment identity, revision and approval fields. Before starting, write down the question the finished record should answer and identify the source information you would need on a real job. Keep a separate list of missing inputs. Prepare a first draft, then compare it with the topic-specific checks above. Ask another person to follow your references without explaining them verbally. Record where they hesitate, what information they cannot locate and any different interpretation. Keep a brief review log with four columns: observation, proposed action, responsible reviewer and closure evidence. Revise the example and repeat the information-finding check. Your evidence of completion is the revised demonstration record plus that log, not simply time spent reading. Do not upload client information to the academy or practise on operating equipment.
What good completion looks like
A useful result can be understood by someone who did not prepare it. They can identify its purpose, applicable item, source and review status, and they can distinguish confirmed information from unresolved questions. Pay particular attention to this failure mode: Remove sample values that could be mistaken for actual test results. Check the output in the format the recipient will use. A native file, spreadsheet and exported PDF can expose different problems. Keep the source revision and the issued output linked, and record any limitations of the handover. On a real project, follow the customer's authorised checking and approval arrangements before the information is used. The knowledge check below tests understanding of this lesson; it does not assess practical competence or authorise regulated work.
Practical workflow
- Establish the source: identify the approved input, document revision and person responsible for its technical content. Record missing information as an open question.
- Prepare a small representative example before applying the approach to a whole project. Check identifiers, units, references and the intended reader’s needs.
- Ask the nominated reviewer to check technical meaning. Capture the response, resolve comments and issue only under the agreed document-control process.
Review checklist
- Can another reader identify the source and applicable revision?
- Are assumptions and unresolved decisions clearly recorded?
- Is there evidence of the required review before issue?
Educational material and demonstration examples. Not accredited training, practical competency assessment or authority to perform regulated work. Use current approved sources and your responsible technical authority on real projects.