Course Title: Create technical documentation

Part B: Course Detail

Teaching Period: Term2 2018

Course Code: ISYS7572C

Course Title: Create technical documentation

School: 174T School of VE Engineering, Health & Science

Campus: City Campus

Program: C4387 - Certificate IV in Telecommunications Engineering Technology

Course Contact: Program Manager

Course Contact Phone: +61 3 9925 4468

Course Contact Email: vocenengineering@rmit.edu.au


Name and Contact Details of All Other Relevant Staff

Kenneth Falzon
Telephone: +613 9925 4716
Email: kenneth.falzon@rmit.edu.au

 

Appointments via email.

 

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

Nil

Course Description

This unit describes the skills and knowledge required to create technical documentation that is clear to the target audience and easy to navigate. It applies to individuals working as technical writers, designers, developers and support staff who are required to produce technical support documents of their work.


National Codes, Titles, Elements and Performance Criteria

National Element Code & Title:

ICTICT408 Create technical documentation

Element:

1. Identify and analyse documentation requirements and client needs

Performance Criteria:

1.1 Consult with client to identify documentation requirements
1.2 Interpret and evaluate documentation requirements and
confirm details with 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 client to validate and confirm the scope of
work

Element:

2. Design documentation

Performance Criteria:

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
according to 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

Element:

3. Develop documentation

Performance Criteria:

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 according to documentation
standards and templates

Element:

4. Evaluate and edit documentation

Performance Criteria:

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

Element:

5. Prepare documentation for publication

Performance Criteria:

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 using appropriate channels


Learning Outcomes


Refer to Elements


Details of Learning Activities

This course is delivered as cluster "Advance Network Project" MKTG7981C Address customer needs (BSBCUS402).

Students will participate in the following teaching methods : lectures and tutorials.


Teaching Schedule

Address customer needs and Create technical documentation

Week of study

Topic

Module Learning outcomes

Learning Activities

1

Introduction to Topic, Overview of course and relevance

 

 

2

Identifying the Customers

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

3

Gather Customer Information

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

4

Translate into Customer Needs

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

5

Organize Needs

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

6

Establish Relative Importance of Needs

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

7

Reflect on Results

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

8

Technical documentation in various applications and with products; purpose; types of documentation to suit customer needs

 

Practical tasks; 
class discussion;

Class Activities;
Tasks as per Participants Guide

9

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

10

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

11

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

12

Discussion

Discussion on Assignment 1 on customer needs

 Assignment 1

13

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

14

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

 

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

15

Evaluate and Edit Document; Digital document design; Using plain English; Editing; proofreading; Contents and indexes Evaluate whether meets client’s needs; Prepare document for publication;

See reading list and online resources; 
Internet;
Workplace documents;
Participants Guide;
PowerPoints Internet;
Workplace documents;
Participants Guide;

Class Activities; 
work place observation; 
Tasks as per Participants Guide; working with identified problem in organisation

16

Discussion

Discussion on Assignment 2 on customer needs 

Assignment 2

17

Assignment 1

Assignment 2

 Address customer needs and Create technical documentation

 

18

Catch up for missed items

 

 


Learning Resources

Prescribed Texts


References


Other Resources

Learning materials available in Canvas.


Overview of Assessment

 

Assessment Tasks

Students must pass each of the following assessment tasks to demonstrate competent.

Assessments

Assessment 1

 Assignment

Assessment 2

 Assignment

These tasks assess the following Course Learning Outcomes (CLOs):

Assessment Mapping Matrix

Elements / Performance Criteria Covered

Assessment 1

Assessment 2

1.1

 X

 X

1.2

 X

 X

1.3

 X

 X

1.4

 X

 X

1.5

 X

 X

2.1

 X

 X

2.2

 X

 X

2.3

 X

 X

2.4

 X

 X

2.5

 X

 X

2.6

 X

 X

3.1

 X

 X

3.2

 X

 X

3.3

 X

 X

4.1

 X

 X

4.2

 X

 X

4.3

 X

 X

4.4

 X

 X

5.1

 X

 X

5.2

 X

 X

5.3

 X

 X

 

To be deemed competent you must demonstrate an understanding of all aspects required of the competency.

 

 


Assessment Tasks

This course is delivered as cluster "Advance Network Project" MKTG7981C Address customer needs (BSBCUS402). Please refer to course guide Part B MKTG7981C.


Assessment Matrix

Assessment Task Elements
Assignment 1 Elements 1, 2, 3, 4 and 5
Assignment 2 Elements 1, 2, 3, 4 and 5

Other Information

Credit Transfer and/or Recognition of Prior Learning (RPL):
You may be eligible for credit towards courses in your program if you have already met the learning/competency outcomes through previous learning and/or industry experience. To be eligible for credit towards a course, you must demonstrate that you have already completed learning and/or gained industry experience that is:

  • Relevant
  • Current
  • Satisfies the learning/competency outcomes of the course

Please refer to http://www.rmit.edu.au/students/enrolment/credit to find more information about credit transfer and RPL.
 

Study and learning Support: 

Study and Learning Centre (SLC) provides free learning and academic development advice to you. 
Services offered by SLC to support your numeracy and literacy skills are: 

assignment writing, thesis writing and study skills advice 
maths and science developmental support and advice 
English language development 

Please Refer http://www.rmit.edu.au/studyandlearningcentre to find more information about Study and learning Support 

Equitable Learning Services (ELS):

If you are suffering from long-term medical condition or disability, you should contact Equitable Learning Services (ELS) to seek advice and support to complete your studies.
Please refer to https://www.rmit.edu.au/students/support-and-facilities/student-support/equitable-learning-services to find more information about services offered by Equitable Learning Services (ELS).

Late submission: 

If you require an Extension of Submittable Work (assignments, reports or project work etc.) for 7 calendar days or less (from the original due date) and have valid reasons, you must complete and lodge an Application for Extension of Submittable Work (7 Calendar Days or less) form and lodge it with the Senior Educator/ Program Manager. 
The application must be lodged no later than one working day before the official due date. You will be notified within no more than 2 working days of the date of lodgment as to whether the extension has been granted. 
If you seek an Extension of Submittable Work for more than 7 calendar days (from the original due date) must lodge an Application for Special Consideration form under the provisions of the Special Consideration Policy, preferably prior to, but no later than 2 working days after the official due date. 

Submittable Work (assignments, reports or project work etc.) submitted late without approval of an extension will not be accepted or marked. 


Special consideration: 

Please Refer http://www.rmit.edu.au/students/specialconsideration to find more information about special consideration 

Plagiarism: 

Plagiarism is a form of cheating and it is very serious academic offence that may lead to expulsion from the University. 

Please Refer: www.rmit.edu.au/academicintegrity to find more information about plagiarism. 

Other Information: 

All email communications will be sent to your RMIT email address and you must regularly check your RMIT emails.

Course Overview: Access Course Overview