Manuals and procedures · Lesson 28 · Approx. 7 minutes including practice
Glossaries and terminology
A shared glossary reduces confusion between engineering, production and service teams. Record preferred terms, permitted abbreviations and context. Review terms with the people who use them and maintain the glossary as products evolve.
Step 1: Collect terms
A documentation workflow, not an equipment operating sequence. Animation starts only when you choose Play.
Use one term for one concept
A glossary is a shared agreement about vocabulary. Start with terms that cause real confusion between design, purchasing, production and service teams. Record a preferred term, definition, permitted abbreviation and relevant context. Avoid defining a term only by another equally unfamiliar abbreviation. Where an industry term has several meanings, explain which meaning applies in this product’s documentation. Keep commercial part descriptions aligned with approved identifiers.
Prepare and check the work
Collect terminology from approved source material and ask the relevant users to resolve inconsistencies. Apply the glossary across headings, illustrations, BOM descriptions and interface labels. Search for obsolete variants when a preferred term changes. Keep a record of the decision so future writers understand why a choice was made. A glossary improves consistency but does not establish the technical validity of a procedure.
Worked example · demonstration only
The same component is called a reel cabinet, hose box and service enclosure in different documents. Confirm the intended concept with the product owner, choose a preferred term and retain useful aliases for searching. Do not merge genuinely different components just because their names sound similar.
Guided practice and review evidence
Use only a demonstration dataset for this exercise: Build a ten-term glossary from one approved manual. 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: Two department nicknames should not become two different part identities. 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.