^

 
 

Unit of competency details

ICAICT301A - Create user documentation (Release 1)

Summary

Usage recommendation:
Superseded
Mapping:
MappingNotesDate
Supersedes and is equivalent to ICAD3218B - Create user documentationOutcomes deemed equivalent. Added application of unit. Changes to range statement, required skills and knowledge and evidence guide. 17/Jul/2011
Is superseded by and equivalent to ICTICT301 - Create user documentationUpdated to meet Standards for Training Packages. 24/Mar/2015

Release Status:
Current
Releases:
ReleaseRelease date
1 1 (this release) 18/Jul/2011

Accredited courses that have this unit in the completion mapping

Training packages that include this unit

Classifications

SchemeCodeClassification value
ASCED Module/Unit of Competency Field of Education Identifier 020399 Information Systems, N.e.c.  

Classification history

SchemeCodeClassification valueStart dateEnd date
ASCED Module/Unit of Competency Field of Education Identifier 020399 Information Systems, N.e.c.  04/Nov/2011 
The content being displayed has been produced by a third party, while all attempts have been made to make this content as accessible as possible it cannot be guaranteed. If you are encountering issues following the content on this page please consider downloading the content in its original form

Modification History

Release 

Comments 

Release 1

This Unit 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 user documentation that is clear to the target audience and easy to navigate.

Application of the Unit

This unit applies to individuals in a range of information and communications technology (ICT) areas who are required to provide documentation to users of their system.

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. Determine documentation standards and requirements

1.1 Determine documentation  requirements

1.2 Investigate documentation and industry standards  for requirements and determine appropriate application to user documentation 

1.3 Design documentation templates using appropriate software and obtain approval from appropriate person 

2. Produce user documentation

2.1 Conduct a review of the subject system, program, network or application in order to understand its functionality

2.2 Gather existing technical, design or user specifications and supporting documentation

2.3 Create user documentation based on template to record the operation of the subject system, program, network or application

3. Review and obtain sign-off

3.1 Submit user documentation to target audience for review

3.2 Gather and analyse feedback

3.3 Make changes to user documentation

3.4 Submit user documentation to appropriate person for approval

Required Skills and Knowledge

This section describes the skills and knowledge required for this unit.

Required skills 

  • communication skills to interact with clients and internal staff
  • literacy skills to:
  • identify content
  • write content
  • research skills to:
  • analyse audience needs
  • identify target audiences
  • technical skills to:
  • determine appropriate content, formats and styles
  • select and use appropriate software and tools.

Required knowledge 

  • content features, including clarity and readability
  • document design, web design and usability
  • functions and features of templates and style guides
  • instructional design principles.

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 create user documentation that:

  • meets business requirements
  • caters for a diverse readership
  • is clear to the target audience
  • is easy to navigate.

Context of and specific resources for assessment 

Assessment must ensure access to:

  • documentation standards
  • software tools for effecting documentation
  • information about system, platform, network or application being documented
  • appropriate learning and assessment support when required
  • modified equipment 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:

  • direct observation of candidate producing documents for users using appropriate software
  • review of candidate’s changes to user documentation based on user feedback
  • verbal or written questioning to assess candidate’s knowledge of functionality of the system.

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.

Documentation  may include:

  • design specifications
  • electronic copy
  • internet and intranet
  • online help
  • training materials in either hard copy
  • user manuals and procedure manuals.

Standards  may include:

  • International Organization for Standardization (ISO), International Electrotechnical Commission (IEC) and Australian Standards (AS) standards
  • organisational standards
  • project standards
  • policy relating to cataloguing, sign-off, storage, distribution and revision.

User documentation  may include:

  • brochures
  • help references
  • online help
  • project specifications
  • reports
  • training materials and self-paced tutorials
  • user guides
  • user manuals.

Software  may include:

  • commercial software applications
  • graphics packages
  • help file creation software
  • multimedia authoring tools
  • organisation-specific software
  • presentation applications
  • word-processing packages.

Appropriate person  may include:

  • authorised business representative
  • client
  • supervisor.

Unit Sector(s)

General ICT