Course Title: Create technical documentation
Part B: Course Detail
Teaching Period: Term1 2012
Course Code: COSC6095C
Course Title: Create technical documentation
School: 155T Vocational Health and Sciences
Campus: City Campus
Program: C4299 - Certificate IV in Information Technology Networking
Course Contact: Geoff Moss
Course Contact Phone: +61 3 9925 4852
Course Contact Email: geoff.moss@rmit.edu.au
Name and Contact Details of All Other Relevant Staff
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.
Pre-requisites and Co-requisites
There are no pre-requisites for this course.
Course Description
This unit describes the performance outcomes, skills and knowledge required to create technical documentation that is clear to the target audience and easy to navigate as prescribed in the ICA11 Information and Communications Training Package.
Technical documentation provides a record of the functionality and processing of a system, program, network or application. The technical documentation should document how the system, program, network or application is structured, how it works and changes that have been made to it.
National Codes, Titles, Elements and Performance Criteria
National Element Code & Title: |
ICAICT408A Create technical documentation |
Element: |
1. Identify and analyse documentation requirements and client needs. |
Performance Criteria: |
1.1 Consult with the client to identify documentation requirements |
Element: |
2. Design documentation |
Performance Criteria: |
2.1 Identify information requirements with reference to layout and document structure |
Element: |
3. Develop documentation |
Performance Criteria: |
3.1 Write technical documentation based on the template and scope of work using the information gathered |
Element: |
4. Evaluate and edit documentation |
Performance Criteria: |
4.1 Submit technical documentation to appropriate person for review |
Element: |
5. Prepare documentation for publication |
Performance Criteria: |
5.1 Check that the completed technical documentation meets client requirements and scope of work |
Learning Outcomes
Students will develop an understanding of how to create technical document and its relevance to their activities in the workplace and the IT industry and its importance within the IT industry and within the organisation.
They will produce simplified documentation for a simple identified problem within their workplace (this may be a theoretical exercise rather than a practical exercise, depending on the organisation and the status of its ethical practices).
Details of Learning Activities
Activities in this course are aimed at enhancing student understanding and knowledge of creating technical documentation and its application in the workplace and the IT profession.
This learning unit consists of five competencies covering the knowledge and skills to assist students in preparing technical documentation, up to the stage of preparation for publication. These outcomes will be obtained largely through learning by doing a range of activities, tasks and an assignment in class and in the workplace. The focus of the course will be on the documentation that occurs within the workplace and the IT industry in general.
The Internet and YouTube videos will be used as a learning tool and a resource for students to seek and locate relevant information.
Learning activities may be modified during the semester to meet the needs of students in the current program and the needs of their workplace.
Teaching Schedule
Teaching for this course will involve both in class activities and activities in the workplace focused on the documentation needs of the organisation and the documentation that the organisation produces.
Weeks | Topic | Software / Reading | Practical Exercises | Assessment |
1 | Introduction to Topic, Overview of course and relevance to traineeship and workplace; technical documentation in various applications and with products; purpose; types of documentation | Participants Guide Create Technical Documentation; PowerPoints | Class Activities; Tasks as per Participants Guide |
Practical tasks; class discussion; Assignment |
2 | Types of documentation; Copyright; document standards - industry and organisation; document control and revision, storage and revision. Client requirements, scope. | See reading list and online resources; Internet; Workplace documents; Participants Guide; PowerPoints |
Class Activities; work place observation; Tasks as per Participants Guide |
Practical tasks; class discussion; Assignment |
3 | Designing documentation; Design tools; systems requirements; flow charts; style documents and templates; format of documentation | See reading list and online resources; Internet; Workplace documents; Participants Guide; PowerPoints |
Class Activities; work place observation; Tasks as per Participants Guide; working with identified problem in organisation |
Practical tasks; class discussion; Assignment |
4 | Develop Documentation: Document Structure, Style documents; templates; design and mapping of documents; use of images and graphics | See reading list and online resources; Internet; Workplace documents; Participants Guide; PowerPoints |
Class Activities; work place observation; Tasks as per Participants Guide; working with identified problem in organisation |
Practical tasks; class discussion; Assignment |
5 | Evaluate and Edit Document; Digital document design; Using plain English; Editing; proofreading; Contents and indexes | See reading list and online resources; Internet; Workplace documents; Participants Guide; PowerPoints |
Class Activities; work place observation; Tasks as per Participants Guide; working with identified problem in organisation |
Practical tasks; class discussion; Assignment |
6 | Evaluate whether meets client’s needs; Prepare document for publication; | See reading list and online resources; Internet; Workplace documents; Participants Guide; |
Assignment | Assignment |
Learning Resources
Prescribed Texts
References
Other Resources
Participants Guide for ICAICT408A Create Technical Documentation ;
Create technical documentation Activity Booklet
Internet references and reference sites
Overview of Assessment
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.
Assessment methods have been designed to measure achievement of each competency in a flexible manner over a range of assessment tasks. It will incorporate a variety of methods including technical requirements; documentation; workplace activities; class discussions, exercises and activities; quizzes; practical problem solving exercises and presentations.
You must demonstrate an understanding of all elements of a particular competency to be deemed competent.
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.
Assessment Tasks
Class and Work-Based Assessment Activities
Class Assessment Tasks
Assignment
All assessments need to be successfully completed to pass the course.
Assessment Matrix
Element / Criteria | Assignment | Practical Tasks | Class / Work Observation | Class Testing | Individual and Group Discussion |
1.1 | x | x | x | x | |
1.2 | x | x | x | ||
1.3 | x | x | x | x | x |
1.4 | x | x | x | x | |
1.5 | x | x | x | x | |
2.1 | x | x | x | x | |
2.2 | x | x | |||
2.3 | x | x | x | ||
2.4 | x | x | x | x | |
2.5 | x | x | x | x | |
2.6 | x | x | x | ||
3.1 | x | x | |||
3.2 | x | x | x | x | x |
3.3 | x | x | x | ||
4.1 | x | x | x | ||
4.2 | x | x | x | x | |
4.3 | x | x | x | x | |
4.4 | x | x | x | ||
5.1 | x | x | x | x | |
5.2 | x | x | |||
5.3 | x | x | x | x | |
Other Information
Access to an internet connected computer outside of class times – Internet connected computers are available in the School of Life & Physical Sciences labs on levels 4, 6 or 8 of building 51, 81 Victoria Street, Melbourne.
Further lab access can be found in the student lab on level 3 (ground floor) of Building 8, in Swanston Street, Melbourne; as well as RMIT Libraries.
Students who have a long term medical condition and/or disability may be able 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.
Course Overview: Access Course Overview