NTISthis.com

Evidence Guide: ICTICT408 - 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

 

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

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

Required Skills and Knowledge

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.