Modification History
|
Version |
Comments |
|
ICAICT408A |
This version first released with ICA11 Information and Communications Technology Training Package version 1.0 |
Unit Descriptor
This unit describes the performance outcomes, skills and knowledge required to create technical documentation that is clear to the target audience and easy to navigate.
Application of the Unit
This unit applies to technical writers, designers, developers and support staff who are required to produce technical support documents of their work.
Technical documentation provides a record of the functionality and processing of a system, program, network or application. The technical documentation should document how the system, program, network or application is structured, how it works and changes that have been made to it.
Licensing/Regulatory Information
No licensing, legislative, regulatory or certification requirements apply to this unit at the time of endorsement but users should confirm requirements with the relevant federal, state or territory authority.
Pre-Requisites
Not applicable.
Employability Skills Information
This unit contains employability skills.
Elements and Performance Criteria Pre-Content
|
Element |
Performance Criteria |
|
Elements describe the essential outcomes of a unit of competency. |
Performance criteria describe the performance needed to demonstrate achievement of the element. Where bold italicised text is used, further information is detailed in the required skills and knowledge section and the range statement. Assessment of performance is to be consistent with the evidence guide. |
Elements and Performance Criteria
|
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 |
Required Skills and Knowledge
This section describes the skills and knowledge required for this unit.
Required skills
- communication skills to interact with clients and staff
- literacy skills to:
- identify content
- interpret standards and industry requirements
- write content
- research skills to:
- analyse audience needs
- identify target audiences
- technical skills to:
- determine appropriate content, formats and styles
- use word-processing software and multimedia authoring tools.
Required knowledge
- content features, such as clarity and readability
- document design, web design and usability
- functions and features of templates and style guides
- instructional design principles
- organisational policies, procedures and standards that cover document design.
Evidence Guide
The evidence guide provides advice on assessment and must be read in conjunction with the performance criteria, required skills and knowledge, range statement and the Assessment Guidelines for the Training Package.
|
Overview of assessment |
|
|
Critical aspects for assessment and evidence required to demonstrate competency in this unit |
Evidence of the ability to:
|
|
Context of and specific resources for assessment |
Assessment must ensure access to:
Where applicable, physical resources should include equipment modified for people with special needs. |
|
Method of assessment |
A range of assessment methods should be used to assess practical skills and knowledge. The following examples are appropriate for this unit:
|
|
Guidance information for assessment |
Holistic assessment with other units relevant to the industry sector, workplace and job role is recommended, where appropriate. Assessment processes and techniques must be culturally appropriate, and suitable to the communication skill level, language, literacy and numeracy capacity of the candidate and the work being performed. Indigenous people and other people from a non-English speaking background may need additional support. In cases where practical assessment is used it should be combined with targeted questioning to assess required knowledge. |
Range Statement
The range statement relates to the unit of competency as a whole. It allows for different work environments and situations that may affect performance. Bold italicised wording, if used in the performance criteria, is detailed below. Essential operating conditions that may be present with training and assessment (depending on the work situation, needs of the candidate, accessibility of the item, and local industry and regional contexts) may also be included.
|
Client may include: |
|
|
Requirements may refer to: |
|
|
Documentation standards may include: |
|
|
System may include: |
|
|
Technical documentation may include: |
|
|
Content may include: |
|
|
Appropriate person may include: |
|
|
Channels may include: |
|
Unit Sector(s)
General ICT
Custom Content Section
Not applicable.
