National Occupational Standards
- Element 9.1 - Plan the composition of text for inclusion
in a technical publication
- Element 9.2 - Produce text to cover the content of
a technical publication
- Element 9.3 - Review text with other people
This unit describes the competence required from technical communicators
when creating text for inclusion in a technical publication. Technical communicators
have to confirm the purpose and scope of the technical publication, identify
the main aspects of the subject matter, and then plan the composition of the
text to effectively communicate that subject matter. They then have to produce
the text, selecting a suitable vocabulary for the users, ensuring that the
text is free of errors, and recording and protecting the text in the appropriate
information systems. They have to review the text with the relevant people,
identifying any errors, omissions, inconsistencies, or redundant text. Finally
they have to revise the text to take account of any issues identified in the
review process.
Evidence Requirements
Evidence of performance and knowledge is required. Evidence of performance
should be demonstrated by activities and outcomes, and should be generated
during the course of normal activities, unless indicated under Assessment
Methods (see below). Evidence of knowledge can be demonstrated through performance
or by responding to questions. A variety of assessment methods can be used
(see below).
Quantity and scope of evidence:
Evidence should show that the candidate can undertake this unit consistently
over a suitable period. The number of times, or the amount of experience,
cannot be specified in detail. However, it is important that the candidate
provides performance evidence of having undertaken this unit a minimum of
two times. Further guidance will be developed during the implementation of
the qualifications.
Assessment methods:
A number of assessment methods are listed below. The ticks and crosses indicate
which methods are or are not recommended. However, these are recommendations,
and this is not a list of sanctioned or prohibited methods: it is up to individual
assessors to determine which assessment methods are suitable in individual
cases. In addition, other assessment methods might be appropriate. Further
guidance will be developed during the implementation of the qualifications.
Recommended Assessment Methods |
|
|
|
direct observation of the candidate by the assessor |
√ |
outputs (eg publications) produced by the candidate in their normal activities |
√ |
outputs (eg publications) produced by the candidate as special exercises |
x |
supporting documents (eg memos, notes, correspondence) |
√ |
responses to questions from the assessor |
√ |
written answers to questions |
x |
testimony of others who have witnessed the candidate achieving the standards |
x |
Evidence Guidance
Examples of Evidence:
- Direct evidence
- Correspondence with the client
- Drafts of text
- Final text
- Organisational records
- Supplementary evidence
- Contract/order notes/job sheet
- Correspondence, memos, faxes, and e-mail
- Design specification for technical publication
- Information notes provided by the client
- Information used in the technical publication
- Technical specifications
Key words in this unit that can be found in the glossary:
- client
- components of the technical publication
- content
- error
- information systems
- people
- revision
- style
- technical publication
- text
- users
- vocabulary
You must be able to:
- Confirm the purpose and scope of the technical publication
- Identify the main aspects of the subject matter that need to be conveyed
- Determine how the text can effectively communicate the subject matter
- Outline the sections of the text and their objectives
- Order the sections of text to produce a logical structure
- Identify any problems with the potential composition of the text
You must be able to apply knowledge of:
- Composition of text
- what is the subject matter of the technical publication
- how to order sections of text to produce a logical structure
- what types of problem can occur with the composition
You must be able to:
- Obtain all the technical details that need to be incorporated into the
text
- Produce text to effectively convey the required content
- Select a vocabulary that is suitable to the users of the technical publication
- Ensure the text is free from errors according to the agreed procedures
- Produce text in the formats required in the technical publication
- Record and protect the text in the appropriate information systems
You must be able to apply knowledge of:
- Text
- what is the content that needs to be conveyed
- what types of vocabulary and style are suitable to different types
of user
- what types of error could occur within the text
- what types of format are required for different types of technical
publication
- Information systems
- which systems should be used
- why it is important to use the systems correctly
You must be able to:
- Review the text with the relevant people
- Identify any errors, omissions, or inconsistencies in the text that need
to be corrected
- Identify any text that is redundant and can be removed
- Revise the text effectively to meet the requirements of the client and
users
- Ensure health and safety requirements are implemented in the text
- Recommend to the relevant people any improvements to the technical publication
- Record and protect the revised text in the appropriate information systems
You must be able to apply knowledge of:
- Review of text
- who should review the text
- what are the types of error, omission, or inconsistency that might
be found in the text
- what type of text is often redundant and can be removed
- why it is important to ensure health and safety requirements are implemented
- Information systems
- which systems should be used
- why it is important to use the systems correctly
© Crown Copyright, 1999,
© Publishing Training Centre, 1999,
© ISTC, The Institute of Scientific and Technical Communicators, 1999 |
