NTISthis.com

Evidence Guide: ICAICT408A - Create technical 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

 

ICAICT408A - Create technical documentation

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

Identify and analyse documentation requirements and client needs

  1. Consult with client to identify documentation requirements
  2. Interpret and evaluate documentation requirements and confirm details with client
  3. Investigate industry and documentation standards for requirements
  4. Define and document the scope of work to be produced
  5. Consult with client to validate and confirm the scope of work
Consult with client to identify documentation requirements

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Interpret and evaluate documentation requirements and confirm details with client

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Investigate industry and documentation standards for requirements

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Define and document the scope of work to be produced

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Consult with client to validate and confirm the scope of work

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Design documentation

  1. Identify information requirements with reference to layout and document structure
  2. Create document templates and style guides consistent with information requirements
  3. Conduct a review of the system in order to understand its functionality
  4. Extract content that meets information requirements according to copyright restrictions
  5. Develop the structure of the technical documentation giving focus to the flow of information, style, tone and content format
  6. Validate the technical documentation structure with the client
Identify information requirements with reference to layout and document structure

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Create document templates and style guides consistent with information requirements

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Conduct a review of the system in order to understand its functionality

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Extract content that meets information requirements according to copyright restrictions

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Develop the structure of the technical documentation giving focus to the flow of information, style, tone and content format

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Validate the technical documentation structure with the client

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Develop documentation

  1. Write technical documentation based on the template and scope of work using the information gathered
  2. Translate technical terminology into plain English where appropriate
  3. Apply content format and style according to documentation standards and templates
Write technical documentation based on the template and scope of work using the information gathered

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Translate technical terminology into plain English where appropriate

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Apply content format and style according to documentation standards and templates

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Evaluate and edit documentation

  1. Submit technical documentation to appropriate person for review
  2. Gather and analyse feedback
  3. Incorporate alterations into the technical documentation
  4. Edit the technical documentation for technical and grammatical accuracy
Submit technical documentation to appropriate person for review

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Gather and analyse feedback

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Incorporate alterations into the technical documentation

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Edit the technical documentation for technical and grammatical accuracy

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Prepare documentation for publication

  1. Check that the completed technical documentation meets client requirements and scope of work
  2. Submit the technical documentation to appropriate person for approval
  3. Prepare the technical documentation for publication and distribution using appropriate channels
Check that the completed technical documentation meets client requirements and scope of work

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Submit the technical documentation to appropriate person for approval

Completed
Date:

Teacher:		 Evidence:

 

 

 

 

 

 

 

Prepare the technical documentation for publication and distribution using appropriate channels

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 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.

Context of and specific resources for assessment

Assessment must ensure 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

appropriate learning and assessment support when required.

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:

direct observation of candidate reviewing a system to establish its functionality

verbal or written questioning to assess candidate’s knowledge of copyright and other requirements relating to technical content

review of technical documentation developed by candidate.

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.

Required Skills and Knowledge

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.

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:

external organisations

individuals

internal departments

internal employees.

Requirements may refer to:

business

network

organisational policies

people in the organisation

system.

Documentation standards may include:

audit trails

International Organization for Standardization (ISO), International Electrotechnical Commission (IEC) and Australian Standards (AS)

naming conventions

organisational standards

policy relating to:

distribution

revision

sign-off

storage

project-management templates and report-writing principles

version control.

System may include:

business

computers

financial

information

management

network

software.

Technical documentation may include:

brochures

help references

online help

operational procedures

reports

self-paced tutorials

system design

system functionality

system or project specifications

technical manuals

training materials

user guides.

Content may include:

information and interactive features:

background articles

company information

copyright and disclaimer notices

customer only information

customer-specific information

error messages

feedback mechanisms

forms

frequently asked questions

hyperlink titles

instructions

product information

ratings or rankings

testimonials

quotes from reviews

reference pages

site map

what's new.

Appropriate person may include:

authorised business representative

client

supervisor.

Channels may include:

animation and graphics provided through books

audio

CDs

computer-based tutorials

DVDs

help screens

manuals

text

world wide web.