Technical Documents

This page addresses these topics:

Definition of "Technical Documents"

Applications for Technical Documents

Training Documents

Websites can be Technical Documents

"Technical Documentation" Defined

As opposed to marketing documents which excite potential customers to buy your product or service, technical documents provide user information in any form -- printed, electronic, or web-based on the internet or your intranet, and accomplish the following:

	Train users to use a product
	Describe the features of a product so users can readily find the information they need
	Show users how to make the most efficient use of product features to complete their tasks
	Provide conceptual material that helps the user understand how the product works with other products.

Technical documents are always about products or processes that help users do their work better.

Users are generally considered to be customers, but may also be employees who must use a new tool/ part/ procedure on their job.

Applications for Technical Documentation

1. The most obvious technical document is a User Guide / Manual.

Whenever you produce a new product or service, you should have a technical writer create one of these to be shipped/ delivered with every order/ application. That way your customer will have a booklet/ manual to

	help familiarize himself with your product/ service
	answer questions that may come up
	get hints on solving problems that may arise
	train others in using your product/ service

Can you see how this application will reduce calls to your Help Desk or Customer Service personnel?

2. Business owners need written Procedures

As a business grows, an owner delegates responsibilities to employees s/he trusts to manage parts of the enterprise. However, to stay on top of what's happening, an owner needs to know what's going on in each department.

Here's where written procedures are a vital necessity:

	The recorded procedure is followed exactly each time the process is repeated
	Records can be kept to indicate whether the process is producing quality results
	If records indicate a change is recommended to increase quality results, you can use the written procedure to pinpoint where the change is needed
	You can update your written procedure easily once the improvement is adopted

Written procedures can take the format of either:

graphics, in the form of flowcharts,
or, as general documents that follow a standardized category-and-number format

Training Employees

Many employers will state that training their employees to do their work correctly and consistently is one of the most difficult tasks to accomplish in a business.

Approaching your business with the following techniques will encourage greater success in this area:

	Team Building and Employee Involvement
	Statistical Process Control

Both of these techniques require that customized technical documentation be designed, created, and applied to fit your particular business ethics and deliverables. Once applied, you will see dramatic improvements in employee attitudes and outcomes.

Software Training

Companies benefit by having the assistance of a proficient trainer who can develop course material using technical documentation techniques, and then delivering those principles to your employees.

Creating a Website for your business

Why have a website? See the page.

It's not just for SELLING your product or service!

A website is truly technical documentation when it delivers any of the topics addressed on this page --

    helping customers understand your product / service

    publishing procedures that customers or employees need to know

    using the internet / intranet as a training tool for employees

Once you develop a website, doesn't it make sense to use it for all the above purposes?

Functioning as your business partner, I can customize any strategy described above to suit your particular business needs.

To schedule a FREE confidential consultation, call toll-free 800-464-0203, or send e-mail.