Ethiopia TVET System ASella TVET college

Unit of competency title Create Technical Documentations

Unit of competency code ICT HNS3 04 0710

Unit Purpose
On completion of this unit, the trainees should be able to create technical documentation.

More specifically, the trainees should be able to:

 identify and analyse documentation needs
 design documentation
 develop documentation
 evaluate documentation

Technical documentations and the need for documentations

What is Technical Documentation?

Technical documentation is the generic term for documentation with regard to a

product [product should have a documentation]. People mainly associate the term
with the documents and information that are passed on to the public by the
manufacturer.

Technical documentations are prepared for user instructions, operating instructions,

servicing instructions, installation manuals and software manuals

The term technical documentation refers to different documents with product-related

data and information that are used and stored for different purposes.

 “Different purposes” mean: Technical documentation contains product definition

and specification, design, manufacturing, quality assurance, product liability,
product presentation; description of features, functions and interfaces; intended,
safe and correct use; service and repair of a technical product as well as its safe
disposal.

This broader view, in which all documents that are generated during the product life
cycle are viewed as part of the technical documentation is certainly justified. After all,
the aim is to make available the technical know-how and product history for
subsequent users of the information.

Sector: Information Communication Technology Page 1

 Ethiopia TVET System ASella TVET college

The focus for service providers in the field of technical documentation is, however,
mainly on documents that are required after the production process —the reasons
are simple:

 It creates great demands since the documents should have

comprehensibility/lack of confusion/ and clarity.
 The documents itself are passed on to the public, i.e. are part of the public
presentation of the manufacturer
 For the design of the documents, relatively little manufacturer-specific
knowledge and know-how — especially no company secrets — are normally
required. Instead, a lot of experience with the tools and target media is required,
what becomes particularly apparent in case of an online publication such as help
system.

Computer users need documentation so that they can make the best use of their
computers as work tools. User documentation helps users to learn a system and/or
application software, and to get help when they experience problems. Creating user
documentation involves the steps of planning, writing and reviewing user
documentation to ensure it meets organisational and industry standards, as well as
user requirements.

Type of Documentation and appropriate media

Books, manuals, computer-based tutorials and online help are all media for user
documentation. Traditionally user documentation has consisted of a range of paper-
based documents. However, we are no longer limited to these, and organisations are
shifting their paper-based user documentation to an online form. There are very
good reasons for this:
1. Increased Productivity — users have up-to-date, comprehensive information that
they can access quickly and easily.
2. Increased Corporate Intelligence — information is stored centrally but
distributed universally
3. Consistency and Quality — documentation appears in the same format and is
easily updateable
4. Reduced Printing Costs.

Sector: Information Communication Technology Page 2

 Ethiopia TVET System ASella TVET college

FActivity 1
What user documentation are you familiar with? Make a list of the different kinds of
user documentation you have used or you are familiar with, both personally and at
work. /5 points/
After completing, checking points are:

Product definition and specification, TD is prepare for ..., design, descriptions of features, etc.

Samples for your activity on paper- based documentation

- How to install system software, Application software./installation manual/
- How to share files and folders sharing in networking. /user Instruction/
- How to create data base./user instruction/
- How to operate instruction /e.g. saving html files to be interpreted by web browser/
- How to update Anti-virus/Servicing instruction/
- How to document software manual.

Purpose of user documentation

Users might need to consult a range of documentation in order to install, configure
and/or use the functions of a system or application. There are many different
types of user documentation depending on what users require. For example, a new
staff member using a particular IT system for the first time needs to refer to a user
guide and tutorials and online help. In other words, they firstly need
documentation that helps them learn to use the software. As they become more
familiar with the system, they will need access to other types of documentation such
as FAQs (Frequently Asked Questions).

F Activity 2
Think of the types of user documentation you have seen at a workplace. Do some of
your examples include the following? [N:B. Data base]

Documentation Description
type
Project specifies the detailed business requirements of the
specifications project including how the system will work and the
underlying functionality
Reports produced by the system, program, network or application
Help resources Provides online Help, quick reference cards, scenarios,
FAQs (Frequently Asked Questions). Users can search for
help on using of a specific system, program, network or
application
User manual/guide describes how the user will use a system, program,
network or application to do their job

Sector: Information Communication Technology Page 3

 Ethiopia TVET System ASella TVET college

Training materials train staff in how to use a system, program, network or

application to do their job
Self-paced tutorials teach staff how to use a system, program, network or
application to do their job. These may be online or paper-
based tutorials.
Brochures outline what a computer application does
Project specification: determine how the project will work
Reports: How the project is developed
Help Resources: Link a reference for users help.[steps to function ...]
Users manual/guide: How the user will use the system/project.
Training Material: a document that trains the users of the project.
Self- paced tutorials:

F Activity 3
Think about documentation you have used and recall why you needed to refer to it.
What was the main purpose of the documentation? What did it enable you to do?
These are some examples of user documentation and their purpose.

Examples Purpose
A project specification, training manual, to learn how to use a piece of
user guide, tutorials or help that provides software
step by step guidance in how to use the
software.
A training manual, quick reference guide to refer to a specific feature of a
or user guide that provides detailed piece of software
commands and specifications of a
software package to assist with
troubleshooting problems.

Users’ needs

A need analysis is a process where the needs of the target groups for the
documentation are identified and analysed to decide the most suitable content and
format of the documentation. /Q. give your example for a need analysis/analysing the
need of target group/. For example, Data Entry staff in a call centre need to
know how to correctly enter data in a database so that orders can be
generated correctly from a database.
For training materials and online help a needs analysis should be conducted in person
with the staff who will need the documentation. For other documentation a look at the
needs of the users without speaking directly to staff is sufficient.

Sector: Information Communication Technology Page 4

 Ethiopia TVET System ASella TVET college

After considering user characteristics and needs, possible solutions can be found, for
example:

User User need Possible solutions

characteristic
level of computing beginner to expert create different sections for different
experience levels of experience
experience with beginner to expert create different sections for
the particular different levels of experience
system or
application
frequency of use constant, frequent to there must be initial training with
with a particular weekly, monthly, some sort of follow-up support
system or annually
application
workplace tasks simple, repetitive tasks documentation must clearly relate to
to complex tasks the tasks at hand

work practices and eg part-time, shift occupational health and safety

environment work, office, documentation is essential
warehouse
language skills difficulty reading and  keep language simple, use plain
understanding written English
language to very  explain technical terms and jargon
competent readers if they must be used
 avoid long uncommon words if
simple words will do

Sector: Information Communication Technology Page 5

 Ethiopia TVET System ASella TVET college

cultural background language appropriate  use language appropriate for all

to some users may not users
be appropriate for  American spelling often appears
others in documentation, since it is often
where the software originates
personal users will learn at make sure individual needs are
characteristics such varying pace catered for organisational policies
as aptitude,
educational
background, age,
disability
level of confidence users might be fearful  be positive and encouraging in
and not confident with your approach
computers  avoid reinforcing negative
attitudes

It’s almost impossible to cater for all these variations. However in preparing
documentation for a new user, you would obviously not confuse them with technical
jargon on the first page! You need to find a balance and remember that any
documentation must be consistent with the organisation’s policy,
conventions and standards.
For any form of documentation to be useful it must be designed with the needs of its
potential users in mind. An analysis of the requirements of the users, and the way their
needs can be effectively addressed, is a critical step in the process of determining
documentation requirements.

What to include in user documentation

It’s a good idea at this stage to think about the content that you will include in the user
documentation. This is so you can estimate the number of pages, the complexity of
the content and what the graphic and text components will be.
The content will have some influence on:
 design of the documentation, including layout, use of text and graphics
 medium, eg paper-based or online
 the time and resources needed to develop the documentation
Media for user documentation
You can consider paper-based documentation, online documentation or a combination
of both. The media type you choose will be influenced by the:

Sector: Information Communication Technology Page 6

 Ethiopia TVET System ASella TVET college

1. purpose of the documentation

2. user needs and characteristics
3. content (subject matter)
Always keep in mind that you need to include a range of items that allow users to
access the required information quickly and easily. There are advantages and
disadvantages to online and paper media.

Media Advantages Disadvantages

Paper  conventional, most people are used  hard to maintain control
to paper products of different versions
 easy and fast to prepare  costly to update
 inexpensive to produce
 requires readily available software
Online  convenient  can be expensive
 easy to reach many people  requires specialised
geographically dispersed software
 can be colourful and fun
 can link to other related documents
 easy to maintain version control
 not costly to update

F Activity 4
Think about when you would be most likely to use paper and when you would use
online.
Paper is appropriate in most circumstances. It is the most commonly used method of
delivering documentation, so most people are used to it and like it. However, when
staff are dispersed across a country or around the world, online delivery is best.
Everyone can access the same documentation and only one version is available.
Where user documentation is going to be used primarily as a help tool, then online
help is most appropriate. It allows for easy searching across the documentation.

N.B. Include the design in ur documentation

Design the document
The main purpose of the Design Document is to integrate all the parts of the design
in a single coherent/consistent/ document. This document will also serve the
following purposes:
1. To be used to review the complete system design at each iteration of the design
process.

Sector: Information Communication Technology Page 7

 Ethiopia TVET System ASella TVET college

2. To be a guide for the developers to follow in the code development phase.

3. To serve as a reference document in the maintenance and enhancement phases
and in design of follow-on or related products.

It should be organized in to two main parts:

A. General Design (also called Conceptual Design)

B. Detailed Design (also called Technical Design).

General Design Document

The General Design Document is intended for non-technical groups or those who wish
to see only an introductory description of the design. It is largely all in a natural
language with some accompanying diagrams.

Its contents can be roughly as follows:

1. The types of users this document is intended for.
2. The overall functions of the system. /how the system is functioning/
3. The hardware/software platform(s) required to operate the software.
4. The types of users involved in the system and the functions available to them.
5. The major data objects (files/databases) created and maintained by other
systems which are used by this system.
6. The major data objects (files/databases) created and/or maintained by this
system.
7. Summary of interfaces with other systems.
8. Reports which can be produced by the system.
9. References and other appendices as required.

Detailed Design Document

This document is intended for the programmers who will implement the code for the
project. Therefore it makes the design very clear and unambiguous. This is not to say
that the implementers will not have to make any decision at all; but that those
decisions should not have major effects on the systems operation, performance,
security or reliability.

This document is based on the Software Requirements Specification (SRS) and

therefore makes references to the appropriate sections and paragraphs of the SRS as
needed to justify design decisions.

Designing templates
Once you have determined the documentation requirements, you can develop a
template that meets those requirements and makes the job easier. A template is a file
that contains a standard layout, styles and fonts that are used in the production of
the documentation.

Sector: Information Communication Technology Page 8

 Ethiopia TVET System ASella TVET college

When you want to create a file for user documentation, you open the standard
template, usually in Word, and the layout, fonts and styles are already set up in the
document. All you need to do is start writing. Everyone uses the same template, so
there is a consistent look and feel to all of the user documentation.
The template may be:
 a Word template
 an HTML template
 an online help template.
The medium will determine what kind of template you use.

Features of templates

Paper-based documentation
Features that may be included in paper-based documentation are:
 table of contents
 columns and tables
 page and section numbering
 headers and footers
 graphics and text surrounds
 substantially chunked information.

Online documentation
Features that may be included in online documentation are:
 table of contents hyperlinks
 tables
 links to other pages/sites
 navigation icons
 usability/functionality
 heavy use of graphics.

Obtaining sign off on templates

Like all documentation, templates also need to be signed-off by the relevant people.
The sign off process will be outlined in the organisational documentation policy.
The content of the template will depend on the purpose of the documentation. A
template for training materials will look quite different to a template for a procedural
manual.

Sector: Information Communication Technology Page 9

 Ethiopia TVET System ASella TVET college

The template should be designed in consultation with users or a subject expert. Once
the template has been designed, it should be distributed according to the user
documentation policy, or, the agreed review process if you are working towards final
sign-off.

Types of user documentation

When a new computer application is implemented or changes are made to existing

computer applications, documentation that explains how the computer application
works may need to be provided directly to users and/or to the help desk.
There are different types of documentation that can be available for each computer
application, for example:
1. user manual/guide
2. technical manual/guide
3. training manual/resources.
When software is purchased off-the-shelf it usually comes with a user guide and
technical guide. Training resources are then either purchased or developed in-house.
When computer applications are developed internally, a user guide, technical guide
and training resources are usually developed to support the application. If the
development is outsourced then the same supporting materials are usually developed
as part of the project. Outsourcing occurs when external staff are hired to develop
the computer application.
So, client documentation for software applications is generally prepared by the
people/organisation who design and develop the application.
A user guide shows the user:

 how to use the application, i.e. the steps required to complete various tasks
 screens dump with dummy/model/ data to give the user a complete picture of
how to enter data and process the data [model]
 tutorials
Note that this guide can incorporate a training resource such as a tutorial.

The technical manual generally contains the technical information such as:

 system requirements to run the application

 how to install the application
 configuring the application

Sector: Information Communication Technology Page 10

 Ethiopia TVET System ASella TVET college

 database layout (if a database is used)

 screen layouts
 how to get technical support.
At the end of any project to develop a computer application, a copy of all
documentation should be provided to the client and help desk
The help desk can then provide support to users when they contact them for support.

Providing support to clients for macros/templates

Just like computer applications, macros and templates need to be supported by the
help desk. When new templates have been developed or new macros set up in
standard software packages, copies of the templates and lists of macro codes and
purpose should be sent to the help desk.
When staff members contact the help desk because a template is being troublesome
or a macro is not working, they can consult these documents to assist the staff
member.

Reviewing the system, program, network or application

Before you can start writing documentation, you need to know how the system,
program, network and/or application that you are documenting works.

Using a user’s perspective

The only way to find out how the system, program, network or application works is to
become a user so that you become familiar with its features and you are confident in
using it.
You should be looking at:
 the functionality — how it works
 the work processes surrounding its use — how the system works with
organisational processes and procedures.
Other valuable sources of information are staff members who are already users or
project team members who have been working with the system.

Gathering existing documentation

If you are writing documentation for an existing system, program, network and/or
application, some documentation may already exist. You should consult any existing
documentation that may have accompanied the system (including technical
information). This could include:
 user guides

Sector: Information Communication Technology Page 11

 Ethiopia TVET System ASella TVET college

 project specifications
 online help
 procedure manuals.
These documents will show you how the system, program, network or application
works. It should also show you what the organisation’s work procedures are and how
to apply them.

Writing effective user documentation

As a confident user of the system you can begin to write the documentation using the
agreed template and relevant tools. You will need a template for user documentation
and the relevant tools for development.

Planning content
In the same way that you plan any piece of writing, you will need to create a plan for
writing the documentation. Before you write the user documentation, write an outline
of the contents. Organise the content into:
1. Main headings
2. Sub headings
3. Points under each of the subheadings.
It might be necessary to approach a subject matter expert to assist with the planning
or it might be sufficient to use any existing documentation as a model for the new
documentation.
When writing the content, it is important to follow effective writing principles. Other
features such as graphic design and navigation will help user documentation work for
users. Along with getting the content right, you’ll need to use sound principles for
layout and usability as well.
A final stage in the development of your documentation will be testing the
documentation with real users, then revising the documentation and testing it again.
So you’ll have the opportunity to adjust content and other features to better fit the
needs of your target users.
Tips for writing and designing effective user documentation
Use this as a checklist for planning the features of user documentation.

Content features
 Give a brief introduction where you state the purpose and objectives of the
documentation.
 Include a table of contents or index
 When writing, keep the users’ needs in mind, i.e. put yourself in the users’ place.

Sector: Information Communication Technology Page 12

 Ethiopia TVET System ASella TVET college

 Ensure the content is accurate.

 Make clear sections for different types of features/information.
 Break the content down into easy-to-digest ‘chunks’, e.g. using paragraphs and sub
headings, or multiple screens.
 Use illustrations, diagrams, charts and/or screen shots where appropriate.
 State instructions clearly and step-by-step.
 Use plain English and avoid jargon.
 Use technical terms only where necessary.
 Include a troubleshooting or help section.
 Include a glossary of the technical terms you have used.

Layout features
 Make the document structure as simple as possible and logical by providing cues to
locate information.
 Ensure good usability, especially for online documentation.
 Cross-reference information, e.g. use hyperlinks in online documentation.
 Warnings, comments and help should be well-organised and visible.
 Aim for a clean design for text styles and layout that is consistent across all pages.

Involving business units in the development of user documentation

One of the reasons a project could fail is that people in the business units who will be
impacted by the project’s implementation have been left out of the consultation
process. From the beginning to end of a project, project team members need
to work closely with users. They are an invaluable resource for developing
documentation.
Though users and subject matter experts from the business units might not have the
skills necessary to write effective documentation, they have the content knowledge. If
you can tap into this knowledge your content will be accurate and relevant.

F Activity 5
What do you think may be the benefits of involving users and accepting their
feedback?
 The end product is more closely aligned with the needs of the users.
 The process of creating user documentation is much simpler due to the expert
knowledge users bring.

Sector: Information Communication Technology Page 13

 Ethiopia TVET System ASella TVET college

 Implementation and take-up of the new system, program, network or application is

much greater with user involvement, as the subject matter experts can act as
‘champions’ within the business units.

Developer tools
The writing tools you use will be determined by the medium — paper-based or online.
Tools (software) can include applications for:
 word processing
 image editing
 image conversion (to web-ready)
 painting and drawing
 HTML conversion/authoring/editing
 FTP utility
 site management software
 multimedia or slide show authoring
 audio and video equipment and editing software.

If you are developing paper-based materials, useful tools are:

 word processing software, e.g. Microsoft Word
 imaging software, e.g. Adobe Photoshop and/or Adobe Illustrator.
If your materials are going online, useful tools are:
 HTML conversion/authoring/editing
 imaging software, e.g. Adobe Photoshop or Fireworks
 FTP utility, e.g. FTP Pro or CuteFTP.

Quality assurance (QA)

Once the documentation has been written, a quality assurance check should be
conducted before the draft is sent out for review. This check is best done by a subject
matter expert, another member of the project team or a different writer.

QA checklist
A standard checklist should be used to check the documentation. A QA checklist
contains a list of standard formats and styles that reflect the organisation’s user
documentation standards.

Sector: Information Communication Technology Page 14

 Ethiopia TVET System ASella TVET college

The purpose of the checklist is to ensure the documentation standards are followed
and that all user documentation is consistent in style and appearance. Once the QA is
complete, the documentation can be sent for a formal review.
The following table lists some of the criteria you could include in a QA checklist.

Criteria Evidence to look for

Is the medium suitable?  consider work practices, frequency of updates
Are the purpose and objectives  objectives stated
clear?  outcomes measurable
 achievable given the stated skill level of
intended users
Is the documentation suitable for  plain language
the intended audience?  terms explained
 user-centred
Is the skill level of the user stated?  skills required to understand and perform tasks
specified
Is the content complete and well  clear sections
organised?  pages/screens numbered
 summaries included
 trouble shooting section included
 content matches objectives
Is it easy to access and navigate Access points include:
the information?  table of contents
 well-developed index with accurate matches
 cross referencing
 hot spots (online)
 glossary
 legend to explain any symbols
Are instructions clear?  one task in one instruction
 instructions are numbered
 technical jargon avoided, explained where
necessary, and located in the glossary
Logical flow of information  topics build on the preceding topic and increase
in level of difficulty
Ease of use  users can find what they are looking for
 users understand it

Sector: Information Communication Technology Page 15

 Ethiopia TVET System ASella TVET college

 users believe it is complete and accurate

Consistency in layout  heading styles used consistently
 consistent use of fonts, type and size for both
headings and body text
 font types limited to two or three
 consistent use of colour, paragraph styles, etc
Balance of text and white space  adequate use of white space
 information is easy to read and follow
 left justification been used
Visual cues  adequate use of tables, illustrations, colour and
other visual elements
 different kinds of information are clearly
identified for easy reading e.g.
 heading
 main body text
 instructions for user to perform a task at the
computer
 explanations of tasks
 warnings
 screen shots
 system messages
 comments to the user
 shortcuts to functions: function keys
Presentation  document looks interesting to read

Usability testing
Online user documentation requires a test for usability. This means that the interactive
design and navigation should be tested to see whether the user can easily find the
information they are after.
It is preferable for usability testing to be performed by a subject matter expert or a
user (since they will be using the documentation when it is finished). The
organisation’s usability standards can be put into the QA checklist.
F Activity 6: What makes a good user guide?
In your home, locate a manual that you think is effective for how to use one a home
appliance or other technical equipment, such as a microwave, clock radio, DVD player,
computer peripheral, etc.

Sector: Information Communication Technology Page 16

 Ethiopia TVET System ASella TVET college

Look at the manual and try to identify features that make the manual a
good ‘user guide’. List those features.

Feedback

Some of those features may be:

 consistent appearance and layout

 clear bold headings
 highlighted key words
 graphics with labels that show key parts of the appliance
 drawings that indicate how the appliance should be used correctly
 tables that summarise data into a concise format
 symbols that are consistent, e.g. ‘caution’
 use of plain English
 use of the active voice, i.e. ‘do’, ‘don’t’, ‘use’, ‘hold’, etc.

F Activity 7: Usability
Using the same manual you found for Activity 5, conduct a usability test. For example,
think about some specific information you want to find and see how easy it is to find it.
Why was the information or instruction easy or difficult to find?

Feedback

A manual may have good usability due to:

 the features mentioned in Activity 5 Feedback

 a table of contents
 logical sequencing and grouping of the content
 small chunks of related information
 effective illustrations.

A manual may have poor usability due to:

 no index or table of contents (navigation)

 content not being logically sequenced
 no diagrams or graphics
 large paragraphs of text.

Sector: Information Communication Technology Page 17

 Ethiopia TVET System ASella TVET college

F Activity 8: Types of documentation

Can you think of any other types of documentation that may be used to
support a software application or other software (apart from user guides)?

Feedback

Some more examples of documentation are:

 quick-reference cards
 training manuals or tutorials
 flowcharts that show the logic of the application/software
 data models that show the fields in a database
 system architecture diagrams that show the network layout
 template design and macros.

F Activity 9: Online documentation

Increasingly, documentation is provided online, e.g. on a company intranet, where
staff can access this information for themselves.
Can you think of advantages of having documentation available online?

Feedback

There are many advantages to online documentation. Having centralised online

documentation means:

 it can be accessed by staff as and when they need it meaning improved

client efficiency and satisfaction
 centralised documentation can be more easily kept up-to-date than hard
copy documentation
 it is cheaper to store documentation online rather than printing and
distributing copies which quickly become dated.
F Activity 10: Internet user support
Think about what is involved in using an Internet browser application (eg Internet
Explorer) to go to a specific website.
Break down this task into simple instructions for a beginner. List the steps
as you would in a user guide.

Sector: Information Communication Technology Page 18

 Ethiopia TVET System ASella TVET college

Feedback

Here is an example of instructions to go to a website using an Internet browser

application. You may have provided an alternative method for using the browser to
go to a website address. Usually it is best to give beginners just one method. More
advanced users are often interested in alternatives that work for them.

Steps

1. Double-click the desktop icon for Internet Explorer to open your browser.

Desktop icon for Internet Explorer

2. Select Open from the File menu.

The Open screen appears.

3. Enter the website address. For this exercise type in www.tafensw.edu.au

Using the Open box to enter a web address

4. Click the OK button.

5. The website will appear on your screen, within the browser window.

Who reviews the user documentation?

The process for the review of the user documentation is generally outlined in the
organisation’s user documentation policy. If you are working on a specific project, the
project manager may have an approach that they prefer you to use.
Generally, documentation is reviewed by:

Sector: Information Communication Technology Page 19

 Ethiopia TVET System ASella TVET college

1 the designated project team members who have knowledge of the system,
program, network and/or application
2 a subject matter expert.

What is the review process?

The review process varies from organisation to organisation and project to project. The
review process is generally outlined in the organisation’s policy or the project
documents. It may be called something like ‘change control’. A basic process is shown
in the following table:

Sector: Information Communication Technology Page 20

 Ethiopia TVET System ASella TVET college

Review process

Person Role
Technical writer The Technical writer creates the user documentation. They
then manage the process of obtaining feedback from the
project team, SME and key stakeholders and changing the
documentation to meet their needs. The documentation is
then handed to the Project Manager once final sign off is
obtained.
Project team Generally, a small group of members of the project team will
members be designated to perform an initial review the
documentation. If changes are required, the document will
be returned to the Technical writer and the review process
will start again.
Subject matter The documentation will then go to a subject matter expert or
expert (SME) a group of subject matter experts for review. If changes are
required, the document will be returned to the Technical
writer and the review process will start again.
Business unit The business unit stakeholders are generally senior
stakeholders management who have a stake in the system, program,
network and/or application you are writing the
documentation for. These people are generally listed on the
Project Brief, depending on the organisational policy.

What do the reviewers review?

Reviewers tend to concentrate on the content. They evaluate whether it is correct and
complete. Some reviewers will also give feedback on the spelling, grammar and
presentation and how they think a document should be improved.

Analysing the feedback

When the feedback is received the Technical writer will need to determine if the
feedback is valid. If there are doubts, he or she will get clarification from the person
requesting the change until the reason for the change is clear. Generally, changes that
are requested by the reviewers are made.

Version control
When writing documentation of any kind, it is a good idea to have version control
process in place to ensure that changes are not lost and versions are not confused.
This will often be outlined in the user documentation policy.
You may have a personal system that you prefer or may like to use a standard system.

Sector: Information Communication Technology Page 21

 Ethiopia TVET System ASella TVET college

Either way, it is critical to establish how you are going to name and number the
various versions of your documents and to communicate that process to other writers
and reviewers so that everyone is on the same page.
For example, the first draft of a user guide is called ug_draft0.1. After 2 reviews and
changes it becomes ug_draft0.3. When the document has completed its final review
and has been signed off, it becomes ug_version 1.

Documentation sign off

Once the documentation has been reviewed and all of the reviewers are happy with it,
you can send it to the relevant people for sign off.

Who signs off?

The project brief or other document that initiates the system, program, network and/or
application development or upgrade will generally list the project and business unit
stakeholders who are responsible for sign off on all of the deliverables, including
documentation.
These people will include the:
 project owner
 business unit managers where the system, program, network or application is
being implemented
 project manager
 other key stakeholders in support roles such as trainers, human resource officers
and change managers.
This process involves passing the reviewed documentation to each
The sign off process:
of the key stakeholders who have the responsibility for signing-off on the
documentation. Generally, there will not be any further changes requested as the key
stakeholders will rely on the reviewers to identify any necessary changes. However, if
further changes are requested by the key stakeholders, the changes are made and the
review and sign off process starts again.

Sector: Information Communication Technology Page 22

 Ethiopia TVET System ASella TVET college

Activities: each Q has the following point

mentioned in the brace
1. Why needs for documentations?[3]
2. What are the appropriate media for user documentations? Types of user
documentation? What are the merits of online form documentation over
paper based documentation?[7]
3. Show your examples that indicate the purpose of documentation? [3]
4. What is the documentation going to be used for? This is the first question
to ask before starting to create any user documentation. When you are
satisfied that you have an answer, you can then decide what type of
documentation you are going to produce?[3]
5. What does “need-analysis” mean? [2]
6. What are the contents to be included in the documentations? And the
“contents” influences? [6]
7. What are the purposes of designing document? [3 ]
8. Write the two parts of design document and explain?[4]
9. Write the developing tools for both paper-based and online form
documentation. [3]
10. What user documentation are you familiar with? Make a list of the
different kinds of user documentation you have used or you are familiar
with, both personally and at work. [3]
11. Create any one of technical documentation from your team
documentation title.[8]

Sector: Information Communication Technology Page 23