ICAD4217A Create technical documentation

From Wikiversity
Jump to navigation Jump to search
Original image: 'Instructions for Monkeys' http://www.flickr.com/photos/79874304@N00/103725518 by: Jackie

From the official document:

"This unit defines the competency required to create technical documentation that is clear to the target audience and easy to navigate."

Basically, that means ... (translate above into plain english)

You can read more about this unit on the National Training Information Systems Official document for ICAD4217A.

This unit forms part of the following qualifications:


How this unit will help you[edit]

After learning and applying the skills required by this unit you'll be able to demonstrate your skills in:

ELEMENT PERFORMANCE CRITERIA
1. Identify and analyse documentation needs
  1. Consult with the client to identify documentation requirements
  2. Interpret and evaluate documentation requirements and confirm details with the client
  3. Investigate industry and documentation standards for requirements
  4. Define and document the scope of work to be produced
  5. Consult with the client to validate and confirm the scope of work
2. 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 in accordance with relevant 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
3. 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 in accordance with relevant documentation standards and templates
4. 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
5. 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 utilising appropriate channels
  • translate the above elements and performance criteria into plain english and summarise here...

Ideas for learning the required skills[edit]

...

wikiversity technical writing course

Ideas for demonstrating this unit[edit]

The best way to demonstrate these skills is ...

Grading[edit]

If you are demonstrating this unit as part of a formal course, you might find that the unit is graded (meaning you can not only demonstrate your competence, but can also gain a credit or distinction). Your facilitator may already have set criteria that your college uses. If not, here are some ideas for possible credit/distinction activities that you can discuss with your facilitator:

  • ...

Notes and discrepancies[edit]

  • ...

Muri bwa cyane kubona muduha contents without notes