The Daily Reviewer | HelpScribe

How to write interesting headings for documentation

Mar 11, 2010 4:06am

Ok, I'm going out on a limb with this suggestion. However, I've seen a lot of scary statistics lately about how infrequently consumers read documentation. So please suspend your judgement while I think this through; there may be some benefit if you would like your users to actually read your...

Technical writing tips via Twitter

Mar 10, 2010 4:22am

As you can see, I've added Twitter to the HelpScribe blog. I'll use this feature to share short technical writing tips with those who follow my feed. So far, I really like the format. Also, I am impressed with how friendly everyone is in the Twitter community. It seems much more...

Screencasts | How to add your brand

Mar 9, 2010 4:09am

Screencasts are often linked to from multiple locations. Help topics, marketing web pages, knowledgebase and support articles, and more may all be launch points for your screencast. Additionally, the SWF and HTM files may be downloaded by users. Because there are so many entry paths, you may want to include...

Free document templates

Mar 8, 2010 6:52pm

Templates are an essential tool in the technical writer's arsenal. Whether you work in MS Word, Frame Maker, or another word processing program, you'll find that a collection of well-structured templates helps you to create professional documents more efficiently. In this post, I'll start a running list of free templates available...

SEO for Technical Writers | Optimizing your content for search engines

Feb 20, 2010 6:53pm

Technical writers are seeing an increasing amount of their documentation move from print and local installation to online (server-based) formats. As your documents move online, you'll need to consider how to help your users find the information they need. Grab a fresh cup of coffee, this is a long and information-packed...

Technical writing | A dying field?

Feb 15, 2010 6:32am

Over the last decade, the nature of my job has shifted considerably. I remember flipping through thousands of pages of proofs to make sure our user manuals were ready for the printer. Many hours went into these printed manuals, and piles of paper covered my desk on most days. Anyone who...

Standard operating procedures formats and template

Jan 31, 2010 4:50am

The format of your standard operating procedures is very important. Because such documents coordinate tasks for critical operations, often across multiple units, they must be presented in a format that provides clarity and consistency. Uniformity of presentation allows for greater usability in crisis situations. The following guidelines will help you structure...

Screencasts | An overview

Jan 29, 2010 5:01pm

Screencasts are quickly becoming one of the primary instructional tools used to train people on developing software skills. Because they show actual screenshots of the software and how it is used, they make a great compliment to written documentation and cater to viewers with a preference for visual learning. A visual...

Screencasts 2.0 | How to create engagement and add integration

Jan 16, 2010 3:36pm

Slowly, but surely, statistics are emerging that show screencasts are a cost-effective and engaging way to provide instructional content. Now technical writers can focus on how to most effectively integrate screencasts into their documentation in an engaging manner. Video content seems to be very effective for grabbing and holding the attention...

Training manual examples

Jan 8, 2010 10:45am

When you write your next training manual, you may find it handy to have some examples to refer to. This post will serve as a repository for examples of training manuals. I will add to it as I find additional resources. Manuals and tutorials - High Tech Center Training Unit: A...

Communication templates

Jan 7, 2010 4:58pm

Most businesses generate a stunning amount of documentation. Keeping track of internal communications alone can be cumbersome; when you add in documents for your customers, it becomes downright tedious. Communication templates and documentation plans can help you track the purpose of each document, delivery deadlines, staff involved, and more. By using...

How to create an effective screencast | 18 tips

Jan 3, 2010 10:22pm

Screencasts are quickly becoming an essential component of software documentation. They combine visual and auditory learning with text to provide a balanced learning experience. Here are some tips on how to create a screencast that engages viewers and provides maximum results for your efforts. Start by listing the conventions you will...

Technical writing and consumer emotion

Dec 24, 2009 5:12am

Emotion... a concept often neglected in the realm of technology. Some would argue that emotion is of little concern to the technical writer; that logic and accuracy alone are the primary concern when producing documentation. That, like the machines themselves, documents should be correct, and no more. I strongly disagree. After all,...

Excellent software documentation resource

Dec 15, 2009 4:04am

I recently became aware of the wealth of resources available for writing software documentation and user assistance at Indoition.com. This site is filled with useful information, including a comparison of help authoring tools, a checklist for producing clear documentation, a list of XML single-sourcing tools, and many tips for creating high...

Writing manuals for warfare | Take the job?

Dec 5, 2009 7:14pm

Imagine this... your phone rings... a headhunter for the defense industry says hello. You are then offered a lucrative contract that should keep you busy for the next few years. What kinds of products will you be documenting? The recruiter says that information cannot be disclosed unless you agree to accept...

The 10 technical writing books everyone should own

Nov 14, 2009 3:07pm

Here is a list of essential technical writing books. Are they on your shelves? Technical Communication: A Practical Approach (7th Edition) (William Pfeiffer and Kaye Adkins) Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content (Alan Pringle) Developing Quality Technical Information: A Handbook for Writers and Editors (2nd Edition) (Multiple...

When minimalist documentation stinks like old cheese

Nov 10, 2009 4:27am

Today I'm staring at an assortment of new brake parts for my car. My caliper pins are gunked up, so I have to fix them, or continue listening to the awful grinding noise they make when I hit the brakes. I know what to do with most of these parts. You...

Links roundup

Nov 9, 2009 6:14pm

Here are some recent posts from the technical writing community that you won't want to miss... Clear, common language leads to user success: Ben Minson writes about empowering users through clear terminology and how the entire development team can succeed by putting users first. Intellectual Property Responsibilities of Content Developers: Paul Pehrson...

Adding screenshots in help topics

Nov 9, 2009 4:43pm

Here are a few tips for adding screenshots to your help topics. Use contrast Use a high-contrast color for callouts, arrows, and other elements that reference screenshots. Avoid any color that is heavily used in the screenshot. I often see black callouts over screenshots with black interface elements. Such visual elements are hard...

White paper writing | Strategies for success

Oct 29, 2009 3:51pm

White papers are a fundamental part of your marketing arsenal. And if you think technical writers don't need to worry about marketing, read on to see why white paper writing is an essential skill, and how to turn a ho-hum paper into a killer communications tool. If you are a freelance...

The Jetsons, and technology running amok

Oct 11, 2009 5:52pm

Tonight I'm watching The Jetsons with my kids. It's a very enlightening cartoon. In fact, I've never seen a better argument for the need for technical writers. Every morning George is flung from his bed and conveyed through a slew of machines that dress, groom, and feed him before flinging him...

Training manual DOC files

Oct 11, 2009 5:14pm

Writing a manual from scratch? A training manual template in DOC format will help you produce a high quality document using Microsoft Word. You can get professional templates using the link below. GET TRAINING MANUAL DOC TEMPLATES - The "User guide", "Training plan", or "Employee handbook" templates might serve your needs. A template...

How to archive documents

Sep 30, 2009 5:14pm

Knowing how to archive documents is essential to an efficient workflow. Think about it; you work hard to create the documents your organization needs to be effective. Why risk losing that hard work? Archives ensure that you can recover any lost documents, and make it easier to track the specific...

Document automation - Word

Sep 27, 2009 8:21am

This article contains tips and getting-started information for documentation automation with Microsoft Word. MS Word has incredibly useful VBA features that allow you to automate routine documentation tasks. You can use the Record Macro feature to automate many repetitive actions, such as retagging paragraph styles, searching and replacing content, and so...

Technical writers are building customer loyalty

Sep 21, 2009 6:54pm

Think closely about the many technical products you've used throughout your life. Microwave ovens, CB radios, lawnmowers, DVD players, computer software... we're surrounded such products and depend on them. Chances are you have favorites; perhaps a laptop computer or portable mp3 player. Chances are you loathe some products, and avoid them at...