NTISthis.com

Evidence Guide: ICAD3218B - Create user documentation

Student: __________________________________________________

Signature: _________________________________________________

Tips for gathering evidence to demonstrate your skills

The important thing to remember when gathering evidence is that the more evidence the better - that is, the more evidence you gather to demonstrate your skills, the more confident an assessor can be that you have learned the skills not just at one point in time, but are continuing to apply and develop those skills (as opposed to just learning for the test!). Furthermore, one piece of evidence that you collect will not usualy demonstrate all the required criteria for a unit of competency, whereas multiple overlapping pieces of evidence will usually do the trick!

From the Wiki University

 

ICAD3218B - Create user documentation

What evidence can you provide to prove your understanding of each of the following citeria?

Determine documentation standards and requirements

  1. Determine documentation requirements
  2. Investigate documentation and industry standards for requirements and determine appropriate application to user documentation
  3. Design documentation templates using appropriate software and obtain approval from appropriate person
Determine documentation requirements

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

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

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

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

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Produce user documentation

  1. Conduct a review of the subject system, program, network or application in order to understand its functionality
  2. Gather existing technical, design or user specifications and supporting documentation
  3. Create user documentation based on template to record the operation of the subject system, program, network or application
Conduct a review of the subject system, program, network or application in order to understand its functionality

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Gather existing technical, design or user specifications and supporting documentation

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

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

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Review and obtain signoff

  1. Submit user documentation to target audience for review
  2. Gather and analyse feedback
  3. Make changes to user documentation
  4. Submit user documentation to appropriate person for approval
Submit user documentation to target audience for review

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Gather and analyse feedback

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Make changes to user documentation

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Submit user documentation to appropriate person for approval

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Assessed

Teacher: ___________________________________ Date: _________

Signature: ________________________________________________

Comments:

 

 

 

 

 

 

 

 

Instructions to Assessors

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 following is essential:

Assessment must confirm the ability to create user documentation that meets business requirements, caters for a diverse readership, is clear to the target audience and easy to navigate

To demonstrate competency in this unit the person will require access to:

Documentation standards

Software tools for effecting documentation

Access to information about system, platform, network or application being documented

Context of and specific resources for assessment

The breadth, depth and complexity of knowledge and skills in this competency would cover selecting, adapting and transferring skills and knowledge to new environments and providing technical advice and some leadership in resolution of specified problems. This would be applied across a range of roles in a variety of contexts with some complexity in the extent and choice of options available.

Assessment must ensure:

Performance of a defined range of skilled operations, usually within a range of broader related activities involving known routines, methods and procedures, where some discretion and judgement is required in the section of equipment, services or contingency measures and within known time constraints would be characteristic.

Applications may involve some responsibility for others. Participation in teams including group or team coordination may be involved.

Method of assessment

The purpose of this unit is to define the standard of performance to be achieved in the workplace. In undertaking training and assessment activities related to this unit, consideration should be given to the implementation of appropriate diversity and accessibility practices in order to accommodate people who may have special needs. Additional guidance on these and related matters is provided in ICA05 Section 1.

Competency in this unit should be assessed using summative assessment to ensure consistency of performance in a range of contexts. This unit can be assessed either in the workplace or in a simulated environment. However, simulated activities must closely reflect the workplace to enable full demonstration of competency.

Assessment will usually include observation of real or simulated work processes and procedures and/or performance in a project context as well as questioning on underpinning knowledge and skills. The questioning of team members, supervisors, subordinates, peers and clients where appropriate may provide valuable input to the assessment process. The interdependence of units for assessment purposes may vary with the particular project or scenario.

Guidance information for assessment

Holistic assessment with other units relevant to the industry sector, workplace and job role is recommended

An individual demonstrating this competency would be able to:

Demonstrate some relevant theoretical knowledge

Apply a range of well-developed skills

Apply known solutions to a variety of predictable problems

Perform processes that require a range of well-developed skills where some discretion and judgement is required

Interpret available information, using discretion and judgement

Take responsibility for own outputs in work and learning

Take limited responsibility for the output of others

Maintain knowledge of industry products and services

Required Skills and Knowledge

Required skills

Selecting and using appropriate software and tools

Identifying target audiences

Analysing audience needs

Identifying relevant content

Determining appropriate content, formats and styles

Writing content

Required knowledge

Content features, such as clarity and readability

Instructional design principles

Functions and features of templates and style guides

Document design, web design and usability

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 but are not limited to:

user manuals and procedure manuals

training materials in either hard copy

electronic copy

on-line help

internet/intranet

design specifications

Standards

May include but are not limited to policy relating to cataloguing, sign-off, storage, distribution, revision

May include ISO/IEC/AS standards, organisational standards, project standards. For further information refer to the Standards Australia website at: www.standards.com.au

Software may include but is not limited to:

commercial software applications; organisation-specific software, word processing packages, graphics packages, presentation applications, multimedia authoring tools and help file creation software

Appropriate person may include:

supervisor

teacher

authorised business representative

client

User documentation

User documentation can include project specifications, reports, help references, user manuals, training materials and self-paced tutorials, on-line help, user guides, brochures