Application
This unit describes the skills and knowledge required to create technical documentation that is clear to the target audience and easy to navigate.
It applies to individuals working as technical writers, designers, developers and support staff who are required to produce technical support documents of their work.
No licensing, legislative or certification requirements apply to this unit at the time of publication.
Elements and Performance Criteria
ELEMENT | PERFORMANCE CRITERIA |
Elements describe the essential outcomes. | Performance criteria describe the performance needed to demonstrate achievement of the element. |
1. Identify and analyse documentation requirements and client needs | 1.1 Consult with client to identify documentation requirements 1.2 Interpret and evaluate documentation requirements and confirm details with client 1.3 Investigate industry and documentation standards for requirements 1.4 Define and document the scope of work to be produced 1.5 Consult with client to validate and confirm the scope of work |
2. Design documentation | 2.1 Identify information requirements with reference to layout and document structure 2.2 Create document templates and style guides consistent with information requirements 2.3 Conduct a review of the system in order to understand its functionality 2.4 Extract content that meets information requirements according to copyright restrictions 2.5 Develop the structure of the technical documentation, giving focus to the flow of information, style, tone and content format 2.6 Validate the technical documentation structure with the client |
3. Develop documentation | 3.1 Write technical documentation based on the template and scope of work using the information gathered 3.2 Translate technical terminology into plain English where appropriate 3.3 Apply content format and style according to documentation standards and templates |
4. Evaluate and edit documentation | 4.1 Submit technical documentation to appropriate person for review 4.2 Gather and analyse feedback 4.3 Incorporate alterations into the technical documentation 4.4 Edit the technical documentation for technical and grammatical accuracy |
5. Prepare documentation for publication | 5.1 Check that the completed technical documentation meets client requirements and scope of work 5.2 Submit the technical documentation to appropriate person for approval 5.3 Prepare the technical documentation for publication and distribution using appropriate channels |
Evidence of Performance
Evidence of the ability to:
establish customer needs
design and develop technical documentation, such as system, procedures, training material and user guides, incorporating appropriate standards
update document with client feedback
prepare documentation for publication.
Note: If a specific volume or frequency is not stated, then evidence must be provided at least once.
Evidence of Knowledge
To complete the unit requirements safely and effectively, the individual must:
describe content features, such as clarity and readability
outline the principles of document design, web design and usability
explain the functions and features of templates and style guides
explain instructional design principles
list organisational policies, procedures and standards that cover document design.
Assessment Conditions
Gather evidence to demonstrate consistent performance in conditions that are safe and replicate the workplace. Noise levels, production flow, interruptions and time variances must be typical of those experienced in the general information and communications technology (ICT) industry, and include access to:
technical specifications
documentation standards
organisational resources and documentation
information about system, platform, network or application being documented
relevant standards
appropriate word processing software.
Assessors must satisfy NVR/AQTF assessor requirements.
Foundation Skills
This section describes language, literacy, numeracy and employment skills incorporated in the performance criteria that are required for competent performance.
Skill | Performance Criteria | Description |
Reading | 1.2, 1.3, 2.3, 2.4, 4.2, 4.4, 5.1 | Identifies and evaluates organisational documentation and standards, and a range of online and hard copy text containing technical project related terminology and diagrams, then applies the information to the development of appropriate technical documentation Interprets and comprehends a large range of diagrams, icons, and computer generated text |
Writing | 1.4, 2.2, 2.5, 3.1-3.3, 4.3, 4.4, 5.3 | Uses correct spelling and grammar, plain English and specific terminology relevant to the project Uses organisational naming conventions, terminology, style and format to develop technical documents to organisational standards |
Oral communication | 1.1, 1.3-1.5, 2.1, 2.3, 2.6, 4.1, 4.2 | Elicits and evaluates information using effective listening and questioning techniques Uses simple and relevant language to confirm understanding of requirements, present information and obtain feedback |
Interact with others | 5.2 | Selects the appropriate form, channel and mode of communication for a specific purpose relevant to own role |
Navigate the world of work | 1.3, 2.4 | Appreciates the implications of legal and regulatory responsibilities related to own work and is beginning to recognise some general legal principles applicable across work contexts |
Get the work done | 1.4, 2.1, 2.2, 2.5, 3.3, 4.2 | Takes responsibility for planning and organising own workload, identifying ways of sequencing and combining elements for greater efficiency Uses familiar digital systems and tools to access, organise, analyse and display information relevant to role Automatically implements standard procedures for routine decisions |
Sectors
General ICT