Course Title: Create technical documentation
Part B: Course Detail
Teaching Period: Term1 2012
Course Code: COSC5430C
Course Title: Create technical documentation
School: 155T Vocational Health and Sciences
Campus: City Campus
Program: C4293 - 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
Teacher: Geoff Moss
Phone: 9925 4852
Email: geoff.moss@rmit.edu.au
Office: 51.07.01
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
Not Applicable
Course Description
This unit defines the competency required to create technical documentation that is clear to the target audience and easy to navigate.
National Codes, Titles, Elements and Performance Criteria
National Element Code & Title: |
ICAD4217B Create technical documentation |
Element: |
1. Identify and analyse documentation needs 1.1 Consult with the client to identify documentation requirements |
Performance Criteria: |
. |
Element: |
2. Design documentation 2.1 Identify information requirements with reference to layout and document structure |
Performance Criteria: |
. |
Element: |
3. Develop documentation
|
Performance Criteria: |
. |
Element: |
4. Evaluate and edit documentation 4.1 Submit technical documentation to appropriate person for review |
Performance Criteria: |
. |
Element: |
5. Prepare documentation for publication 5.1 Check that the completed technical documentation meets client requirements and scope of work |
Performance Criteria: |
. |
Learning Outcomes
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 It profession. Learning will take place in the classroom as well as in the workplace environment.
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 assignments.
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
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 | Tasks as per Participants Guide | Assignment; Practical tasks; class discussion |
2 | Copyright and standards; document control and revision | See reading list and online resources; Participants Guide; PowerPoints |
Tasks as per Participants Guide | Assignment |
3 | Designing documentation; Design tools; systems requirements; flow charts; style documents and templates; format of documentation | See reading list and online resources; Participants Guide; PowerPoints |
Tasks as per Participants Guide; working with identified problem in organisation | Practical tasks; class discussion and observation |
4 | Structure, design and mapping of documents; use of images and graphics | See reading list and online resources; Participants Guide; PowerPoints |
Tasks as per Participants Guide | Class and workplace assessment |
5 | Editing; proofreading; document control | See reading list and online resources; Participants Guide; | Assignment |
Learning Resources
Prescribed Texts
References
Other Resources
Participants Guide for Create Technical Documentation
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.
Assessment Tasks
Class and Work-Based Assessment Activities
Assignment
All assessments need to be successfully completed to pass the course.
Assessment Matrix
Element | Assignment | Practical Tasks | In Class/Work Observation | In Class Testing | Individual and Group discussion* |
1.1 | x | x | x | ||
1.2 | x | x | x | ||
1.3 | x | x | x | x | x |
1.4 | x | x | x | x | x |
1.5 | x | x | x | ||
2.1 | x | ||||
2.2 | x | x | x | ||
2.3 | x | x | x | ||
2.4 | x | x | x | x | |
2.5 | x | x | |||
2.6 | x | x | |||
3.1 | x | x | |||
3.2 | x | x | |||
3.3 | x | x | x | x | |
4.1 | x | x | x | x | |
4.2 | x | x | x | x | |
4.3 | x | x | x | x | |
4.4 | x | x | x | ||
5.1 | x | x | |||
5.2 | x | x | |||
5.3 | x | x |
** small group discussion and problem solving on variety of issues at appropriate times during delivery of the course
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.
Course Overview: Access Course Overview