Create technical documentation

Formats and tools

Unit Description
Reconstruct the unit from the xml and display it as an HTML page.
Assessment Tool
an assessor resource that builds a framework for writing an assessment tool
Assessment Template
generate a spreadsheet for marking this unit in a classroom environment. Put student names in the top row and check them off as they demonstrate competenece for each of the unit's elements and performance criteria.
Assessment Matrix
a slightly different format than the assessment template. A spreadsheet with unit names, elements and performance criteria in separate columns. Put assessment names in column headings to track which performance criteria each one covers. Good for ensuring that you've covered every one of the performance criteria with your assessment instrument (all assessement tools together).
Wiki Markup
mark up the unit in a wiki markup codes, ready to copy and paste into a wiki page. The output will work in most wikis but is designed to work particularly well as a Wikiversity learning project.
Evidence Guide
create an evidence guide for workplace assessment and RPL applicants
Competency Mapping Template
Unit of Competency Mapping – Information for Teachers/Assessors – Information for Learners. A template for developing assessments for a unit, which will help you to create valid, fair and reliable assessments for the unit, ready to give to trainers and students
Observation Checklist
create an observation checklist for workplace assessment and RPL applicants. This is similar to the evidence guide above, but a little shorter and friendlier on your printer. You will also need to create a seperate Assessor Marking Guide for guidelines on gathering evidence and a list of key points for each activity observed using the unit's range statement, required skills and evidence required (see the unit's html page for details)

Self Assessment Survey
A form for students to assess thier current skill levels against each of the unit's performance criteria. Cut and paste into a web document or print and distribute in hard copy.
Moodle Outcomes
Create a csv file of the unit's performance criteria to import into a moodle course as outcomes, ready to associate with each of your assignments. Here's a quick 'how to' for importing these into moodle 2.x
Registered Training Organisations
Trying to find someone to train or assess you? This link lists all the RTOs that are currently registered to deliver ICAD4217B, 'Create technical documentation'.
Google Links
links to google searches, with filtering in place to maximise the usefulness of the returned results
Reference books for 'Create technical documentation' on This online store has a huge range of books, pretty reasonable prices, free delivery in Australia *and* they give a small commission to for every purchase, so go nuts :)

Elements and Performance Criteria



1. Identify and analyse documentation needs

1.1. Consult with the client to identify documentation requirements

1.2. Interpret and evaluate documentation requirements and confirm details with the 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 the 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 in accordance with relevant 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 in accordance with relevant 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 appropriateperson for approval

5.3. Prepare the technical documentation for publication and distribution utilising appropriate channels

Qualifications and Skillsets

ICAD4217B appears in the following qualifications:

  • ICA40305 - Certificate IV in Information Technology (Websites)
  • ICA40105 - Certificate IV in Information Technology (General)
  • ICA40505 - Certificate IV in Information Technology (Programming)
  • ICA40605 - Certificate IV in Information Technology (Testing)
  • ICA30105 - Certificate III in Information Technology
  • ICA40405 - Certificate IV in Information Technology (Networking)
  • ICA40205 - Certificate IV in Information Technology (Support)
  • ICA40805 - Certificate IV in Information Technology (Multimedia)
  • ICA40705 - Certificate IV in Information Technology (Systems Analysis and Design)
  • PSP52310 - Diploma of Translating
  • CUF50307 - Diploma of Broadcast Technology
  • CUF50207 - Diploma of Interactive Digital Media