Documentation Solutions 
Solving your documentation needs 
providing online help and printed documentation
 
Home      Services

 

Our services
 
We provide quality technical authoring services to our customers creating a variety of online help and printed documentation for both hardware and software products. The single-source methods we use to create documentation gives you the flexibility, if you require, to have your documentation both online and printed.
 
We can provide a variety of documentation solutions. The following list provides some examples, however depending on your product and your customers the solution to your needs may combine some of these guides together.
 
Online help
Online help is topic-oriented, procedural or reference information delivered through computer software. It is a form of user assistance. Most online help is designed to give assistance in the use of a software application or operating system, but can also be used to present information on a broad range of subjects. When online help is linked to the state of the application (what the user is doing), it is called context-sensitive help.
 
Web Help
Web help is a type of online help delivered through the internet. Click here for an example of Web Help that was developed by us.
 
User's Guides
A user guide or user's guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. Most user guides contain both a written guide and the associated images. In the case of computer applications, it is usual to include screenshots of how the program should look, and hardware manuals often include clear, simplified diagrams. A user's guide may contain both procedural and reference information.
 
Reference Manuals
A reference manual or guide is a compendium of information, usually of a specific type, compiled in a book for ease of reference. That is, the information is intended to be quickly found when needed. Reference manuals are usually referred to for particular pieces of information, rather than read beginning to end.
 
Installation Guides
An installation guide contains instructions which guide you through a product's installation process. Depending on the complexity of your product this may be a manual guide, a one page step-by-step procedure, installation wizard, or other similar process description.
 
Getting Started Guides
A getting started guide typically describes the basic tasks required to get your product up and running.
 
Service/Repair Guides
A service/repair guide contains instructions on how to service your product so that it meets its specifications, and how to identify and repair faults with your product.
 
 

How we work

The process of developing documentation begins by us ensuring that the nature of your audience and their need for information is clearly identified. Next we create a documentation plan for you to review and approve. From there our technical author researches and structures the content into a framework that can guide the detailed development. As the documentation is created, the paramount goal is ensuring that the content can be clearly understood by the intended audience and provides the information that the audience needs in the most appropriate format. This process is known as the "Writing Process".

 The technical writing process can be divided into five steps:
  1. Determine purpose and audience
  2. Create and approve a documentation plan 
  3. Collect, organize and outline information
  4. Write the first draft
  5. Revise and edit

© Copyright Documentation Solutions Ltd 2010 - 2011