LEARNING MODULE 07

TVET-PROGRAMME TITLE: Hardware and Networking Service Level III

MODULE TITLE:Create Technical Documentation
MODULE CODE: EIS HNS3 M07 0322
NOMINAL DURATION: 25Hours
MODULE DESCRIPTION: This module covers the competence required to create technical
documentation that is clear to the target audience and easy to navigation.
LEARNING OUTCOMES
At the end of the module the trainee will be able to:

LO1. Identify and analyze documentation needs

LO2. Design documentation

LO3. Develop documentation

LO4. Evaluate and edit documentation

MODULE CONTENTS:

LO1. Identify and analyze documentation needs

1.1.Consulting client to identify documentation requirements

1.2.Interpreting and evaluating documentation requirements

1.3.Investigating industry and documentation standards

1.4.Defining and documenting scope of work

1.5.Consulting client to validate and confirm the scope of work

LO2. Design documentation

2.1. Identify information requirements with reference to layout and structure documented

2.2.Creating document templates and style guides

2.3. Conducting the system review

2.4. Extracting content that meets information requirements

2.5. Validating technical documentation structure

LO3. Develop documentation

 3.1. Writing technical documentation

3.2. Translating technical terminology

3.3. Applying content format and style

LO4. Evaluate and edit documentation

4.1. Submitting technical documentation for review

4.2. Gathering and analyzing feedback

4.3. Incorporating alternatives to the technical documentation

4.4. Editing technical documentation

Learning Methods:
For none Reasonable Adjustment for Trainees with Disability (TWD)
impaired
Low Vision Deaf Hard of hearing Physical impairment
trainees
Lecture-  Provide large print text  Assign sign language  Organize the class  Organize the class room
discussion  Prepare the lecture in Audio/video interpreter room seating seating arrangement to be
 Organize the class room seating  Arrange the class room seating arrangement to be accessible for wheelchairs
arrangement to be accessible to trainees to be conducive for eye to eye accessible to users.
 Write short notes on the black/white board contact trainees  Facilitate and support the
using large text  Make sure the luminosity of  Speak loudly trainees who have severe
 Make sure the luminosity of the light of the light of class room is kept  Ensure the attention impairments on their upper
class room is kept  Introduce new and relevant of the trainees limbs to take note
 Use normal tone of voice vocabularies  Present the lecture  Provide Orientation on the
 Encourage trainees to record the lecture in  Use short and clear sentences in video format physical feature of the work
audio format  Give emphasis on visual lecture  Ensure the attention shop
 Provide Orientation on the physical feature and ensure the attention of the of the trainees
of the work shop trainees
 Summarize main points  Avoid movement during
lecture time
 Present the lecture in video
format
 Summarize main points
Demonstratio  Conduct close follow up  use Sign language interpreter  Illustrate in clear &  Facilitate and support the
n  Use verbal description  Use video recorded material short method trainees having severe upper
 Provide special attention in the process of  Ensure attention of the trainees  Use Video recorded limbs impairment to operate
guidance  Provide structured training material equipments/ machines
 facilitate the support of peer trainees  Show clear and short method  Ensure the attention  Assign peer trainees to assist
 Prepare & use simulation  Use gesture of the trainees  Conduct close follow up
 Provide tutorial support  Provide tutorial  Provide tutorial support
(if necessary) support (if necessary
(if necessary)

Group  Facilitate the integration of trainees with  Use sign language interpreters  Facilitate the  Introduce the trainees with
discussion group members  Facilitate the integration of integration of their peers
 Conduct close follow up trainees with group members trainees with group
 Introduce the trainees with other group  Conduct close follow up members
member  Introduce the trainees with  Conduct close
 Brief the thematic issues of the work other group member follow up
 Introduce the
trainees with other
group member
 Inform the group
members to speak
loudly
 Exercise  Conduct close follow up and guidance  Conduct close follow up and  Conduct close  Assign peer trainees
 Provide tutorial support if necessary guidance follow up and  Use additional nominal hours
 provide special attention in the process  Provide tutorial support if guidance if necessary
necessary  Provide tutorial
 provide special attention in the support if necessary
process/practical training  provide special
 Introduce new and relevant attention in the
vocabularies process/ practical
training
 prepare the assignment questions in large  Use sign language interpreter  Provide briefing
Individual text  Provide briefing /orientation on /orientation on the
assignment  Encourage the trainees to prepare and the assignment assignment
submit the assignment in large texts  Provide visual recorded  Provide visual
 Make available recorded assignment material recorded material
questions
 Facilitate the trainees to prepare and
submit the assignment in soft or hard copy
ASSESSMENT METHODS:
Interview  Use sign language interpreter  Speak loudly  Use written response
 Ensure or conform whether  Using sign language interpreter if as an option for the
the proper communication necessary trainees having speech
was conducted with the challenges
trainee through the service of
the sign language interpreter
 Use short and clear
questioning
 Time extension
Written test  Prepare the exam in large texts  Prepare the exam using short  Prepare the exam using short  Use oral response as
 Use interview as an option if sentences, multiple choices, sentences, multiple choices, true or an option to give
necessary True or False, matching and false, matching and short answers if answer for trainees
 Prepare the exam in audio short answers necessary. having severe upper
format  Avoid essay writing limb impairment
 Assign human reader  Time extension  Time extension for
 (if necessary) trainees having severe
 Time extension upper limb impairment
Demonstration  Brief the instruction or  Use sign language interpreter  Provide activity based assessment  Provide activity based
/Observation provide them in large text  Brief on the instruction of the  Brief on the instruction of the exam assessment
 Time extension exam  Use loud voice  Conduct close follow
 Provide activity-based/  Time extension up
practical assessment method  Time extension
 Time extension
ASSESSMENT CRITERIA:

LO1. Identify and analyze documentation needs

1.1. Consulting client to identify documentation requirements

1.2. Interpreting and evaluating documentation requirements and confirming with client

1.3. Investigating industry and documentation standards

1.4. Defining and documenting scope of work

1.5. Consulting client to validate and confirm the scope of work

LO2. Design documentation

2.1. Identifying information requirements with reference to layout and structure

2.2.Creatingdocument templates and style guides

2.3. Conducting review of the system

2.4. Extracting content that meets information requirements

2.5. Developing structure of the technical documentation

2.6. Validating technical documentation structure

LO3. Develop documentation

3.1. Writing technical documentation

3.2. Translating technical terminology to plain English

3.3. Applying content format and style

LO4. Evaluate and edit documentation

4.1. Submitting technical documentation

4.2. Gathering and analyzing feedback

4.3. Incorporating alterations into the technical documentation

4.4. Editing technical documentation

Annex: Resource Requirements
Create Technical Documentation (EIS HNS3 M07 0322)

Item Category/Item Description/ Quantity Recommended

No. Specifications Ratio
(Item: Trainee)
A. Learning Materials
 Information
sheet
1. TTLM  Job sheet 25 1:1
 Operation
sheet
Learning Facilities &
B.
Infrastructure
High speed
1. Internet 1 1:25
broad band, Wifi
2. Library Multipurpose 1 1:25
Well-ventilated
3. Work shop class room with 1 1:25
IT equipment
4 White board 1.20 X 1.50m 1 1:25
5 Shelves wooden or metal 1 1:25
C. Consumable Materials
1. Blank CD CD-RW 25 1:1
Whiteboard
2 Stationery marker, printing 1 1:25
paper, printer ink
3 San disk or 25 1:1
Flash disk
similar 4-8GB
Terminals,
converters,
4 Connectors splitters ( SATA 25 1:1
to IDE, USB)
splitter
D. Tools and Equipments
1. Computer Hp,Dell 25 1:1
 American
2 Divider 5 1:5
standard
Computer accessories(mouse, key Compatible
3 13 1:2
board, scanner, printer)
4 Projector LCD 1 1:25
5 Switch 16/24 port 2 1:13