technical writing services

Jumping Bean works with you and your programmers to create user friendly technical documentation, such as user guides and online help.

Sell more product

I know, technical writing is often last on your list of things to do. But time and time again, users want documentation. They may not read it straight through, but they like to have it. It's their safety net when they run into difficulties.

Plus, if your product comes with no manual or online help, there's a good chance it will be returned. And that's not good for anyone's bottom line!

Read this informative article from the Society of Technical Communications about how technical writing can increase your business (PDF). (It's an oldie, but a goodie!)

Excerpt
The companies also told us that they recognize the importance of the discipline [Technical Writing]:
  • 74% of respondents said that good documentation tends to lower their servicing costs
  • 83%. said that quality documentation contributes to the company's profitability
  • 91% said that a quality document adds value to the product or service of their company

Create user guides & online help

Need technical documentation? Do you need it in print or online? Windows or Macintosh? We'll develop technical documentation that makes your software solution easy to use and understand.

Types of technical writing services

We primarily focus on technical writing for Windows and Macintosh systems. For each of these operating systems we can develop the following:

  • Basic Online Help
    This is the least expensive option. Basic Online Help provides all of the information your users would need, including an index, searchability, and basic navigation.

  • Context-Sensitive Help
    Context-sensitive help takes the basic online help and brings it up a level. For context-sensitive help, help topics are tied to your application. When a user presses the Help button (the F1 key), a help topic relevant to what he's doing appears. We can implement the necessary tags (provided by your programmer).

  • Context-Sensitive Help + See Also
    Don't know what a "See Also" is? It's the little question mark button that (sometimes) appears at the top right corner of a title bar. You can click this button and then click a field in a dialog box. A small pop-up description of that field appears. Think of it as "ultra context sensitive".

  • Context-Sensitive Help + See Also + Tutorials
    In addition to the context-sensitive help and "See Alsos", we can develop small tutorials. Tutorials would walk users through a task that involves several steps, such as creating an account or making a homemade pizza!

  • Scripts for Movies
    We can write scripts for small multimedia presentations that show how to do something either either with animation (flash, Shockwave) or actors. If the movies/animations are complex, we would partner with a graphic designer. We've created similar movies for SPSS and Open Port Technology.

  • Print and Online Help
    Need something that you can hold in your hand? We can write a hard-bound, print manual that partners with your online help. This can be useful for older users who prefer books. The hard-bound books generally cover more information, such as detailed overviews, pictures, and simple diagrams. We would develop the hard bound book first and then use that information for the context-sensitive help. Printing and illustration costs and the type of binding would be included in the overall project fee.

I thought you only did marketing

Our core business is marketing communications. But we like to write in different mediums. And we know that instead of being tossed in the trash, users will want to keep their user guides and online help for reference.

Take a look

We have a few technical documentation pieces for you to look at on our portfolio site.

Our Writing Services

   
About Us
Our Services
  Build a Creative Team
Our Clients
Our Portfolio


Thanks so much for your promptness—this will be a project that goes on record as going out on time!!

Susan K.
Director of Marketing Communications
Read the case study


 
 
 
  
 tel: 773.764.6413 | fax: 773.913.0418 | info@jumpbean.com
© 2001-2008, Jumping Bean Communications. All Rights Reserved.
Jumping Bean Communications