Course Title: Create technical documentation

Part A: Course Overview

Program: C4293 Certificate IV in Information Technology (Networking)

Course Title: Create technical documentation

Portfolio: SEH Portfolio Office

Nominal Hours: 20

Regardless of the mode of delivery, represent a guide to the relative teaching time and student effort required to successfully achieve a particular competency/module. This may include not only scheduled classes or workplace visits but also the amount of effort required to undertake, evaluate and complete all assessment requirements, including any non-classroom activities.

Course Code	Campus	Career	School	Learning Mode	Teaching Period(s)
COSC5430C	City Campus	TAFE	155T Vocational Health and Sciences	Distance / Correspondence or Face-to-Face or Internet or Workplace	Term1 2012

Course Contact: Geoff Moss

Course Contact Phone: +61 3 9925 4852

Course Contact Email: geoff.moss@rmit.edu.au

Course Description

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

Pre-requisite Courses and Assumed Knowledge and Capabilities

Not Applicable

National Competency Codes and Titles

National Element Code & Title:

ICAD4217B Create technical documentation

Elements:

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 appropriate person for approval 5.3 Prepare the technical documentation for publication and distribution utilising appropriate channels

Learning Outcomes

Overview of Assessment

Critical aspects for assessment and evidence required to demonstrate competency in this unit.
Assessment must confirm the ability to create technical documentation that meets business requirements, caters for a diverse readership, is clear to the target audience and easy to navigate.

Assessment occurs throughout the program and includes learning and assessment activities conducted in the classroom, online and in the workplace giving you the opportunity to practice and be assessed on what you are learning in a work context. You must demonstrate an understanding of all elements of a particular competency to be deemed competent. Assessment methods have been designed to measure achievement of each competency in a flexible manner over a range of assessment tasks.

Assessment will incorporate a variety of methods including technical requirements, documentation, workplace activities, in class exercises, quizzes, practical problem solving exercises and presentations. Participants are advised that they are likely to be asked to personally demonstrate their assessment work to their teacher to ensure that the relevant competency standards are being met.

If you have a long term medical condition and/or disability it may be possible to negotiate to vary aspects of the learning or assessment methods. You can contact the program coordinator or the Disability Liaison Unit if you would like to find out more.