Editing Guidelines for Software Documentation

Software documentation can be difficult to review, so it helps to have some editing guidelines to keep you focused. Let's face it; software documentation isn't exactly exciting reading material. But you should be able to complete the job in a productive manner if you keep your coffee cup full and follow the editing guidelines below.

HelpScribe (2008). Articles>Documentation>Editing>Software

Eleven Tips for Writing Incredibly Useful Procedures

Procedures are the meat and potatoes of technical writing. They help users get the job done. Follow these tips for writing clear and useful procedures that your users will appreciate.

HelpScribe (2008). Articles>Documentation>Policies and Procedures>Technical Writing

HelpScribe Technical Writing

HelpScribe Technical Communication offers tips on writing technical manuals, help authoring, software documentation, and managing a TC career.

HelpScribe (2008). Resources>TC>Technical Writing>Blogs

How to Convince Others of the Importance of Documentation

If you've been a technical writer for long, chances are you've had to convince someone of the importance of documentation. It just comes with the territory. People often don't see the value of writing technical manuals. So how do you convince them?

HelpScribe (2008). Articles>Documentation>Collaboration

How to Entertain Technical Writers

I've often wondered what it would be like to throw a party and invite only technical writers. While we are a diverse bunch, we definitely share some common interests, pet peeves, etc. If you ever happen to arrange such a gathering, here are a few ideas for keeping your guests entertained.

Helpscribe (2008). Articles>Writing>Technical Writing>Collaboration

The Importance of Software Documentation Standards

The look and feel of a help system can differ greatly from one product to the next, as can the writing. So how can the technical writing community emphasize the importance of software documentation standards and create a more unified help experience that users can adapt to?

Helpscribe (2008). Articles>Documentation>Standards>Software

Nine Tips for Writing Better FAQs

Frequently asked questions, or FAQs, are an important part of your product documentation. Writing well-targeted and thorough FAQs allow users to quickly find the answers they need so they can be more productive when using your product. Here are some tips for writing FAQs that will get your users on track quickly and help reduce Customer Support calls.

HelpScribe (2008). Articles>Documentation>Writing>FAQ

Our .CHM Files Don't Work Anymore. Why?

If you are delivering your help from a network location and you notice that .CHM files don't work anymore, don't be surprised. Recent Microsoft updates include tighter security for .CHM files. After installing the updates you can no longer run .CHM files from a network location. However, you can still run a .CHM file on your local machine.

HelpScribe (2008). Articles>Documentation>Online>Help

Simple Ways to Improve the Usability of Help

According to Jacob Nielsen's How Users Read on the Web, usability of web content can be improved drastically by making content more scannable. Many of his ideas would apply equally well to online help. So, how can technical writers leverage this information to make the help for their product more usable?

Helpscribe (2008). Articles>Documentation>Usability>Help

Twenty-Two Tips for Writing Software Documentation Users Will Actually Read

How do you go about writing technical manuals for software without going insane? Here are some guidelines you can follow to maintain your sanity when writing software documentation.

HelpScribe (2008). Articles>Documentation>Rhetoric>Software

Why Write Instructions That No One is Going to Read?

I know that a lot of people never read instruction manuals or online help. But you know what? Some people do.

HelpScribe (2008). Articles>Documentation>Rhetoric>Technical Writing

Current Trends in Technical Communications

Many technical writers are developing usability skills and leveraging them to help improve the product interface. Help is being delivered within the interface itself. Drop-down lists of topics related to an interface component, hint text below a GUI field, and other such embedded user assistance models allow users to get help without leaving the application interface.

Haiss, Craig. HelpScribe (2008). Articles>Documentation>TC