Professional Documents
Culture Documents
Create Technical Documentation
Create Technical Documentation
Reflect
Think of the types of user documentation you have seen at a workplace. Do some of your examples
include the following?
Documentation type Description
1
The purpose of user documentation
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.
Reflect
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
Once you have decided what the purpose of your documentation is and what type of documentation
you are going to produce, you can look at the needs of the potential users of the documentation.
Users’ needs
A needs analysis is a process where the needs of the target groups for the documentation are identified
and analysed. This analysis helps to make decisions on what the documentation should contain and
what format is most suitable. 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.
After considering user characteristics and needs, possible solutions can be found, for example:
User characteristic User need Possible solutions
2
User characteristic User need Possible solutions
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.
3
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.
You can consider paper-based documentation, online documentation or a combination of both. The
media type you choose will be influenced by the:
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
Reflect
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.
4
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.
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.
5
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.
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.
Summary
User documentation that meets users’ needs is the most effective. This reading covered the types and
purpose of user documentation and how users’ needs can be identified and met. We also outlined the
steps involved in preparing effective user documentation, deciding on content and media and designing
templates.
6
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
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:
1 the client
2 the help desk.
The help desk can then provide support to users when they contact them for support.
7
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
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.
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.
Reflect
Think about the features that you have found useful in documentation. What were they?
8
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, ie put yourself in the users’ place.
Ensure the content is accurate.
Make clear sections for different types of features/information.
Break the content down into easy-to-digest ‘chunks’, eg 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, eg 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.
Reflect
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.
9
The process of creating user documentation is much simpler due to the expert knowledge users
bring.
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.
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
10
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.
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.
Table 1: QA checklist
11
Criteria Evidence to look for
and body text
font types limited to two or three
consistent use of colour, paragraph styles, etc
Balance of text and white adequate use of white space
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 eg
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.
Summary
This reading has covered the knowledge and skills required to write user documentation for a new or
upgraded system, program, network or application implementation. We began with ways of reviewing
the existing system, program, network or application. Then we looked at elements for writing and
designing effective user documentation and the range of tools available. Documentation is completed
after a quality assurance check and usability testing which ensure that standards are met.
12
Support clients in a courteous and professional manner
Establishing a courteous and professional manner
Most jobs in the IT industry require you to interact regularly with clients. Some of these interactions
include:
attending to customers’ enquiries and complaints
determining a client’s needs
obtaining feedback from a client with regard to an installation, customisation, or support issue
providing a client with information
providing instruction to a client.
When dealing with clients, it is important for you to ensure you establish and maintain a courteous and
professional manner.
Reflect
Imagine you are a client and you ask an IT Support person for help. What behaviour would you expect
from the IT Support person if you were to consider them courteous? What behaviour would you expect
from them if you were to consider them professional?
Courteous behavior
Behaviour that is considered courteous is:
being friendly
showing respect for the other person, and
Assisting the other person.
Being courteous is an important element of being professional.
Professional behavior
When dealing with clients in a workplace setting, professionalism is critical. Behaviour that is
considered professional is:
being courteous
focusing on the needs of the client
assisting the client to meet their needs
13
following organisational policies and expectations of good conduct
Ensuring the client’s needs have been met.
Another key element to professionalism is doing all of the above within an appropriate timeframe.
Reflect
When was the last time you asked for assistance from the IT department? Did you know what you
wanted? Did you know what was causing the problem you had? How did the IT Support person get the
information they required from you to solve your problem?
Gathering information
It’s important, of course, to collect as much information as possible about:
what is happening
when it started happening
what may have caused it to happen
How urgent it is.
14
More often than not, you will see how things should be done by observing other IT staff and seeing
how they interact with clients.
Reflect
Think about a situation where you have contacted an organisation for assistance. It may be as simple as
calling a telephone company for a telephone number. Do the people you deal with follow pre-
determined steps? Do they always follow these steps no matter how many times you telephone them?
Reflect
Think about how you and your colleagues answer the telephone at work. Is there a standard way you
do this? Were you told when you started work how to answer the telephones, according to
organisational policies?
Most organisations require their staff to answer the telephone with a greeting, identifying the
organisation, the department/section, their name and offering help with an opening statement. For
example:
Good morning. ICT Services. This is Lisa Brown.
How can I help you?
Cultural differences
‘Culture’ refers to the values, beliefs and attitudes shared by a group.
When it comes to communication and interaction, it is important to have respect for the differences
between cultural groups within your organisation.
Reflect
Can you think of any differences in communication style you have noticed when interacting with
someone from a different culture?
The following differences can make effective communication difficult:
language
behavioural expectations
the written word
values.
15
By standardising how interactions should occur, organisational policies and guidelines can help solve
problems arising from cultural differences. When there are clear guidelines, everyone knows what is
expected.
Reflect
Think of the last time you requested help from the IT help desk. In order to get assistance, what type of
feedback did you have to give to the help desk support person?
Summary
In this reading we have covered how to establish a courteous and professional manner when interacting
with clients; determine what the client support needs are and give the client feedback; apply
organisational policy and guidelines to support clients and maintain client contact.
16
Support clients in a courteous and professional manner
Establishing a polite and professional manner
Most jobs in the IT industry require you to interact regularly with clients. Some of these interactions
include:
attending to customers’ enquiries and complaints
determining a client’s needs
obtaining feedback from a client with regard to an installation, customisation, or support issue
providing a client with information
Providing instruction to a client.
When dealing with clients, it is important for you to ensure you establish and maintain a courteous and
professional manner.
Reflect
Imagine you are a client and you ask an IT Support person for help. What behaviour would you expect
from the IT Support person if you were to consider them courteous? What behaviour would you expect
from them if you were to consider them professional?
Courteous behavior
Behaviour that is considered courteous is:
being friendly
showing respect for the other person, and
Assisting the other person.
Being courteous is an important element of being professional.
Professional behavior
When dealing with clients in a workplace setting, professionalism is critical. Behaviour that is
considered professional is:
being courteous
focusing on the needs of the client
assisting the client to meet their needs
17
following organisational policies and expectations of good conduct
Ensuring the client’s needs have been met.
Another key element to professionalism is doing all of the above within an appropriate timeframe.
Reflect
When was the last time you asked for assistance from the IT department? Did you know what you
wanted? Did you know what was causing the problem you had? How did the IT Support person get the
information they required from you to solve your problem?
Gathering information
It’s important, of course, to collect as much information as possible about:
what is happening
when it started happening
what may have caused it to happen
how urgent it is.
18
More often than not, you will see how things should be done by observing other IT staff and seeing
how they interact with clients.
Reflect
Think about a situation where you have contacted an organisation for assistance. It may be as simple as
calling a telephone company for a telephone number. Do the people you deal with follow pre-
determined steps? Do they always follow these steps no matter how many times you telephone them?
Reflect
Think about how you and your colleagues answer the telephone at work. Is there a standard way you
do this? Were you told when you started work how to answer the telephones, according to
organisational policies?
Most organisations require their staff to answer the telephone with a greeting, identifying the
organisation, the department/section, their name and offering help with an opening statement. For
example:
Good morning. ICT Services. This is Lisa Brown.
How can I help you?
Cultural differences
‘Culture’ refers to the values, beliefs and attitudes shared by a group.
When it comes to communication and interaction, it is important to have respect for the differences
between cultural groups within your organisation.
Reflect
Can you think of any differences in communication style you have noticed when interacting with
someone from a different culture?
The following differences can make effective communication difficult:
language
behavioural expectations
the written word
values.
19
By standardising how interactions should occur, organisational policies and guidelines can help solve
problems arising from cultural differences. When there are clear guidelines, everyone knows what is
expected.
Reflect
Think of the last time you requested help from the IT help desk. In order to get assistance, what type of
feedback did you have to give to the help desk support person?
20
Summary
In this reading we have covered how to establish a courteous and professional manner when interacting
with clients; determine what the client support needs are and give the client feedback; apply
organisational policy and guidelines to support clients and maintain client contact.
Active listening
Have you ever tried to do something about a problem before you really understood the problem itself?
It usually doesn’t improve the situation.
Similarly, you need to understand a client’s concern or complaint before you can address it. Effective
questioning and listening are strategies for getting to the crux of a problem. This is especially the case
with client complaints. Even what appear to be trivial complaints can develop into something of
significance, so you must ensure that you have the correct facts. When you are dealing with client
complaints, it is critical that you listen carefully to the facts.
Principle Description
Do more listening than talking. Give the other person time to talk. Show that you are
interested in what they have to say.
Show encouragement. Use non-verbal as well as verbal cues to show you are
listening. For example, maintain eye contact, nod, sit
upright and say ‘yes’ or ‘I see’ at appropriate places,
21
and use a positive tone of voice.
Avoid appearing tense. For example, avoid sitting with arms and legs tightly
crossed and speaking in a hurried and agitated tone of
voice.
Try not to agree or disagree If you feel you have to disagree, wait until the other
right away. person has explained and then disagree, but provide
reasons for your stand.
Show empathy. Imagine yourself in the other person’s position.
Respond to their feelings.
Be ‘other-directed’. In other words, don’t project your feelings or ideas on
them.
Be accepting of the other This means being non-judgmental and non-
person. discriminatory.
Be non-defensive. Instead, admit any errors or oversights on the part of
yourself or your organisation and apologise for that.
Paraphrase (summarise) what In other words, restate key facts, issues, perceptions
the speaker is saying. and interpretations. When you receive a client request,
even a simple one, it’s important to check that you’ve
understood it correctly.
Be aware of the other person’s If you need to ask questions of a sensitive nature, ask
sensitivities. them in a gentle, polite and supportive manner and
tone of voice. Assure confidentiality. Wait for the right
time to ask as well — that is, when the other person is
relaxed and you have gained their confidence.
Reflect every now and again on For example, you might say: ‘So you were quite upset
what the other person is saying. by that behaviour because you felt that it was quite
unfair?’ This shows the other person that you
understand how they feel and that their concerns and
feelings are valid.
Show warmth and support. Smile, where appropriate. Look concerned. Avoid
being cold or abrupt.
Admit it when you’re lost. Avoid pretending to understand. Simply say something
such as: ‘Sorry, could you just say that again?’ Clarify
anything you don’t understand. This lets the other
know that you have been listening and that you
understand what they’re saying.
You’ll need to wait for an appropriate situation to arise to practise your active listening, but such
situations arise more frequently than you’d think. Reflect on these principles and make a genuine
attempt to practise them — it may not be easy, at first.
An alternative to this might be to carry out a role play, but you’ll need to find a partner — say a fellow
student, family member or friend. Set up a particular situation in which your partner can play the role
of a client asking you for help. You can then practise active listening techniques in handling the
situation. You may also be able to do this via a telephone or chat facility.
22
Reflective questioning
Active listening is one technique you’ll need to practise. A related skill is to use reflective questioning
or listening.
Suppose you’ve asked a supervisor for advice on an incident, or you’ve passed a tricky question along
to an expert. Now you want to report back to the client, but you don’t clearly understand the answer or
solution you’ve been given.
If your supervisor’s feedback isn’t clear to you, you can use reflective questioning. This is the
technique of repeating the sentence with a few changes (paraphrase), but phrased as a question.
You will have heard the way some people ask a question, with a rising tone of voice at the end of the
sentence. Look at the following example.
Lance: So you say I should use reflective questions?
Olga: That’s right. A reflective question copies a sentence like an echo, but
changes the wording to say the same thing your way.
23
Reflect
Think of at least one open-ended and one closed question that you could ask a client who has phoned
you at the help desk complaining that their computer is running very slowly.
You may have suggested many different questions. A couple of examples are given below. Do your
questions fit a similar pattern?
Question style Description
Open-ended questions Can you tell me a bit more about the problem?
What kinds of programs are you running at the moment?
Closed questions Was it OK yesterday?
Did you try re-booting?
What-if questions
Use what-if (or hypothetical) questions to explore the possibilities with the client (or on your own).
You’ll also be able to bring out any reservations that you or the client may have. An example of this is:
What if we do not have any flights that week? Can you travel the following week?
Clarification questions
Sometimes what the client is saying may not seem logical or coherent. Information may seem
contradictory. Before you dismiss that information as useless, ask for clarification. Perhaps the client
had not explained in great detail because they had assumed that you had the prior knowledge to
understand what they were saying. Here are a couple of examples:
Which incident happened first?
Was it a pleasant or unpleasant visit?
24
Planning questions
Sometimes your client will need your help to plan ahead. An architect’s work, for example, may
involve planning a house that will accommodate a growing family.
A Property Loans Officer’s work may involve planning repayments. He may ask the following
question:
Do you want to pay off your loan sooner?
Strategic questions
Your client may need your help in working out how to proceed next. One such question may be:
Which position, out of the two we’ve discussed, would you like us to explore next?
Organizing questions
These allow us to structure our information. Without a structure, the information would just be bits and
pieces without any discernable patterns. With a good structure you’ll be able to:
see trends or themes
see how one bit of information fits in with others
Compare and contrast.
Here are some examples of organising questions:
Which of these documents belong to you? We’ll put these in this folder.
Which ones belong to your partner?
Now which ones are in both your names?
Probing questions
Probing questions go deep into the issue or problem. They aim to dig out insights and uncover
underlying causes. Here are some examples:
What kinds of accounting tasks do you find difficult to perform manually?
Why do you find these difficult?
What are these tasks (give details of each)?
How long does it take you to perform each task?
Divergent questions
A client may come to you with a problem. Both of you may already know about the advantages
involved in a certain way of doing things. Now you can both explore the risks. Once you are familiar
with a certain area, you can use divergent questions to help you explore territory that is related to what
you already know. Look at the following example:
25
We’ve now got a list of things and steps you need to undertake to achieve option 1. Now what things
do you need to do to achieve option 2?
Summary
We began with a discussion of the importance of listening actively when determining client requests.
This was followed by an explanation of the reflective questioning technique that can be used to clarify
what has been said — to ensure that you have understood clients correctly. Examples of various types
of questions were given to demonstrate how questions can fulfil a range of functions in your
interactions with clients — such as obtaining client feedback, clarifying and expanding client requests
as well as helping clients plan ahead.
26
Applying organisational policies 6
Types of policies and guidelines 6
The need for organisational policies and guidelines 7
Resolving client complaint 7
Feedback on complaints 7
How to obtain feedback 8
Documentation of complaints 8
Summary 9
Boundaries
It’s important to establish boundaries with the client so that they know what is
appropriate in terms of your role. You should tell clients:
when it is appropriate to speak to you
what topics they can discuss
where they can go to get the appropriate support.
27
approach. You will need to have a clear understanding of the objectives of the
meeting, that is, what you want to have achieved by the end.
28
when there is a significant difference in power or authority between conflicting
parties
if the allegations are serious
if there are serious consequences resulting from the complaint.
When a formal process is required, you need to consult the organisation’s policies
for how to proceed.
Reflect
Imagine you are a client and you ask an IT Support person for help. What behaviour
would you expect from the IT Support person if you were to consider them
courteous? What behaviour would you expect from them if you were to consider
them professional?
Courteous behaviour
Behaviour that is considered courteous is:
being friendly
showing respect for the other person
assisting the other person.
Being courteous is an important element of being professional.
Professional behaviour
When dealing with clients in a workplace setting, professionalism is critical.
Behaviour that is considered professional is:
being courteous
focusing on the needs of the client
assisting the client to meet their needs
following organisational policies and expectations of good conduct
ensuring the client’s needs have been met.
Another key element to professionalism is doing all of the above within an
appropriate time frame.
29
Applying organisational policies
Every client interaction should be guided by the policies and guidelines of the
organisation. This is particularly important with regards to the handling of
complaints. Although policies and guidelines are often documented, they can also
be established ways of behaving that form part of the culture of the organisation.
Reflect
Think about a situation where you, or someone you know, made a complaint to a
company. Did the person you made the complaint to follow a procedure, that is, ask
a specific set of questions? Did they write your complaint down? Did they tell you
what would happen next?
Feedback
If you answered ‘yes’ to these questions, then the person you made the complaint to
was following an organisational procedure or guideline on handling complaints.
30
Reflect
Think of the last time you had someone make a complaint about you. Did you get
some feedback from them about why they were unhappy? If so, think about how
you got that feedback and the type of questions you asked.
Feedback on complaints
In general support situations, when handling complaints the IT Support person
needs feedback on the following:
1 What does the client need? Have I understood the needs of the client correctly?
The client’s need here may be having someone to address the complaint.
2 How can I meet the client’s needs? This involves finding a solution to the
problem. For a complaint, it would mean finding a resolution.
3 Has the client’s complaint been resolved satisfactorily to the organisation’s and
client’s satisfaction? This involves implementing the solution and checking
whether all parties are satisfied.
All three types of feedback are required if client complaints are to be resolved
satisfactorily.
Documentation of complaints
In larger workplaces, most complaints are taken by the IT help desk. When a
complaint is made to IT, it is standard practice to record the complaint in the IT
help desk database.
This is a database that records all of the requests, including complaints, coming in
from the organisation to the help desk. When the complaint is escalated, or it is
resolved, the particulars are recorded in the database. If the complaint is resolved,
the complaint is marked as ‘closed’.
31
Summary
This reading covered effective strategies for dealing with client complaints, resolving
them by applying organisational policy and guidelines, obtaining client feedback
and documenting complaints according to organisational requirements.
32
Figure 2: The types of programs that can be inventoried
Figure 3: You can create, edit, preview and print reports of inventory items
33
Technical manuals form an integral part of the management of the hardware devices
and should, therefore, be a main part of the inventory entry. For example, with
modern hardware devices the manuals are often placed on an accompanying CD in
perhaps a PDF file. Details and location of the CD may form part of the inventory
item data. A decision might be made to print a hardcopy of the manual or in
another instance a manual might be supplied. The locations of these hard copies
should also appear as part of the inventory item data.
Reflect
Upgrades of drivers and firmware are an important part of maintaining the efficacy
of computer hardware. This is software isn’t it? Where do you think it belongs in an
inventory?
Feedback
Some software, such as Basic Input Output System (BIOS), is embedded within an
integrated circuit. This is a special kind of software for hardware, ie somewhere
between hard and soft, called firmware. Other devices such as network and video
cards, printers and scanners, for example, require a special kind of software called
device drivers to instruct the devices how to interact with the operating system.
It is now more common to download drivers and firmware upgrades or ‘flashes’ from
the Internet and, as a consequence, there is little documentation, CDs or packaging.
However, drivers and ‘flashes’ are not software in the general sense and should be
treated as a component part of hardware. Inventory details should include any
upgrades and driver changes, where the drivers may be found on the computer
network or where they may have been saved to CD, for example. All hardware
devices of the same maker and series should be upgraded in the same way and duly
noted in the inventory.
Figure 4 shows how a 3 Com network card installed in an accounting department
PC of XYZ type, designated AD-43, could be maintained.
34
Figure 4: Inventory entry of a 3 Com network card
Reflect
Should you record application software user documentation in a software inventory,
and if so how should you do this?
Feedback
For a large number of user licences there is a small amount of user documentation
because every user does not require the user documentation simultaneously. It is,
therefore, important that the user documentation be adequately detailed in an
inventory to comprehensively detail where the documentation is stored, to what
device it applies, the version number and if the documentation is subject to upgrade
detail.
Figure 5 shows an entry for Microsoft Windows XP.
35
Figure 5: Entering details for Microsoft Windows XP operating system software
Maintaining inventory data
We have discussed what data should be entered into an inventory, what extent of
detail should be required, and defined the inventory differences between software
and hardware requirements. Now we must consider how much data is enough, and
when data should be updated. In any inventory system it is critical that the integrity
of the data be evaluated from time to time to ensure that the data is current and
valid.
Reflect
A network is a dynamic and complex system of hardware and software items and
constantly subject to change — the speed of change being determined by
organisational, statutory, security and currency needs. When should data from an
inventory be updated, archived or deleted?
Feedback
As long as a single piece of hardware or software remains in use in a network then
the item details should not be deleted from the inventory, but a decision may be
made to archive the details. It is therefore important that the people maintaining the
inventory have a good knowledge of what is used on the network. Therefore, at the
time of regular hardware and software audits it might be prudent to cull the data
held in the inventory by archiving and deleting redundant items where necessary.
Figure 6 shows that existing details can be edited. You can add or delete records to
maintain the inventory items.
36
Figure 6: Editing existing details, adding or deleting records
Summary
We began with defining asset and inventory items and then moved on to how to
maintain a hardware inventory, where we have to consider the depth of detail
required. Next we explored how to maintain a software inventory where software is
not owned but a licence is obtained to use that software under certain conditions.
As the content of an inventory is useless unless it can be shown to be current,
factual and easily stored and retrieved, it is crucial to maintain or update all
inventory data.
37
Recorded using software developed for the purpose of inventory control
38
existent, the planning and performance of specifications and system software names
upgrades to equipment can be both time and versions.
consuming and also burdened with problems.
Keyboard
Manufacturer
Model
Serial number
Port type
Mouse
Manufacturer
39
Model
Serial number
Port type
40