Unit of Competency Mapping – Information for Teachers/Assessors – Information for Learners

ICTICT408 Mapping and Delivery Guide
Create technical documentation

Version 1.0
Issue Date: April 2024


Qualification -
Unit of Competency ICTICT408 - Create technical documentation
Description
Employability Skills
Learning Outcomes and 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.
Duration and Setting X weeks, nominally xx hours, delivered in a classroom/online/blended learning setting.

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.
Prerequisites/co-requisites
Competency Field
Development and validation strategy and guide for assessors and learners Student Learning Resources Handouts
Activities 		Slides
PPT 		Assessment 1 Assessment 2 Assessment 3 Assessment 4
Elements of Competency Performance Criteria              
Element: Identify and analyse documentation requirements and client needs
  • Consult with client to identify documentation requirements
  • Interpret and evaluate documentation requirements and confirm details with client
  • Investigate industry and documentation standards for requirements
  • Define and document the scope of work to be produced
  • Consult with client to validate and confirm the scope of work
       
Element: Design documentation
  • Identify information requirements with reference to layout and document structure
  • Create document templates and style guides consistent with information requirements
  • Conduct a review of the system in order to understand its functionality
  • Extract content that meets information requirements according to copyright restrictions
  • Develop the structure of the technical documentation, giving focus to the flow of information, style, tone and content format
  • Validate the technical documentation structure with the client
       
Element: Develop documentation
  • Write technical documentation based on the template and scope of work using the information gathered
  • Translate technical terminology into plain English where appropriate
  • Apply content format and style according to documentation standards and templates
       
Element: Evaluate and edit documentation
  • Submit technical documentation to appropriate person for review
  • Gather and analyse feedback
  • Incorporate alterations into the technical documentation
  • Edit the technical documentation for technical and grammatical accuracy
       
Element: Prepare documentation for publication
  • Check that the completed technical documentation meets client requirements and scope of work
  • Submit the technical documentation to appropriate person for approval
  • Prepare the technical documentation for publication and distribution using appropriate channels
       


Evidence Required

List the assessment methods to be used and the context and resources required for assessment. Copy and paste the relevant sections from the evidence guide below and then re-write these in plain English.

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

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.

Submission Requirements

List each assessment task's title, type (eg project, observation/demonstration, essay, assignment, checklist) and due date here

Assessment task 1: [title]      Due date:

(add new lines for each of the assessment tasks)

Assessment Tasks

Copy and paste from the following data to produce each assessment task. Write these in plain English and spell out how, when and where the task is to be carried out, under what conditions, and what resources are needed. Include guidelines about how well the candidate has to perform a task for it to be judged satisfactory.

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

Copy and paste from the following performance criteria to create an observation checklist for each task. When you have finished writing your assessment tool every one of these must have been addressed, preferably several times in a variety of contexts. To ensure this occurs download the assessment matrix for the unit; enter each assessment task as a column header and place check marks against each performance criteria that task addresses.

Observation Checklist

Tasks to be observed according to workplace/college/TAFE policy and procedures, relevant legislation and Codes of Practice Yes No Comments/feedback
Consult with client to identify documentation requirements 
Interpret and evaluate documentation requirements and confirm details with client 
Investigate industry and documentation standards for requirements 
Define and document the scope of work to be produced 
Consult with client to validate and confirm the scope of work 
Identify information requirements with reference to layout and document structure 
Create document templates and style guides consistent with information requirements 
Conduct a review of the system in order to understand its functionality 
Extract content that meets information requirements according to copyright restrictions 
Develop the structure of the technical documentation, giving focus to the flow of information, style, tone and content format 
Validate the technical documentation structure with the client 
Write technical documentation based on the template and scope of work using the information gathered 
Translate technical terminology into plain English where appropriate 
Apply content format and style according to documentation standards and templates 
Submit technical documentation to appropriate person for review 
Gather and analyse feedback 
Incorporate alterations into the technical documentation 
Edit the technical documentation for technical and grammatical accuracy 
Check that the completed technical documentation meets client requirements and scope of work 
Submit the technical documentation to appropriate person for approval 
Prepare the technical documentation for publication and distribution using appropriate channels 

Forms

Assessment Cover Sheet

ICTICT408 - Create technical documentation
Assessment task 1: [title]

Student name:

Student ID:

I declare that the assessment tasks submitted for this unit are my own work.

Student signature:

Result: Competent Not yet competent

Feedback to student

 

 

 

 

 

 

 

 

Assessor name:

Signature:

Date:

Assessment Record Sheet

ICTICT408 - Create technical documentation

Student name:

Student ID:

Assessment task 1: [title] Result: Competent Not yet competent

(add lines for each task)

Feedback to student:

 

 

 

 

 

 

 

 

Overall assessment result: Competent Not yet competent

Assessor name:

Signature:

Date:

Student signature:

Date: