#31155
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
#30814
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
#30811
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
#30807
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
#30808
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
#30829
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
#30830
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
#30810
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
#30812
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
#30826
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
#30815
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
#30809
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
#33159
Eight Tips for Writing Informative Overview Topics
Overview topics play an important role in creating a positive user assistance experience. Unlike procedures, which deliver critical information on how to solve a problem quickly, overview topics fill in the conceptual details and background "story." Here are some tips for writing thorough and informative overviews.
HelpScribe (2008). Articles>Documentation>Online>Help
#33379
To a non-practitioner, the art of technical writing is a nebulous pursuit to be avoided at all costs. The territory is ripe with jargon and Rube Goldberg devices that are not to be trusted. Besides, who in their right mind would want to be a "Technical Writer" (whatever that is)? But to the artisan, technology and language are the subject and medium in which we create our masterworks.
HelpScribe (2008). Articles>Writing>Technical Writing
#33394
How to Write a Disaster Recovery Plan
Tragic events are a part of life. While we can't predict them, we can prepare for them. Here are some tips on how to write a disaster recovery plan that will keep your organization operating during and after such events.
HelpScribe (2008). Articles>Business Communication>Crisis Communication>Policies and Procedures
#33524
HelpScribe: Great Examples of Technical Writing
Not all manuals are created equal. Some are infused with the character and skill of their creator, and rise above the mere paperweights that line the shelves of used bookstores of small-town USA. Some examples of technical writing are so effective, even enjoyable, that they earn a place in the memory of readers. Here are a few technical writing examples that have earned my admiration.
HelpScribe (2008). Articles>Writing>Technical Writing>Case Studies
#33525
The Importance of Technical Writing
Technical writing serves as a bridge between products and users. It is an essential component of the customer experience. Without accurate documentation, users cannot efficiently learn to use the products they've purchased, and will struggle at best.
HelpScribe (2008). Articles>Writing>Technical Writing
#33608
Ten RoboHelp Tips You Won't Want to Miss
I've been using RoboHelp for nearly a decade now. I started off with an older Word-based version to create WinHelp, and now I work with the HTML version to create WebHelp for locally installed and server-based products. Here are a few RoboHelp tips that I've found useful in my day-to-day help authoring responsibilities.
HelpScribe (2009). Articles>Documentation>Software>Adobe RoboHelp
#33634
Should Your Help Be Moved to a Server?
As broadband Internet access becomes increasingly available, software providers are minimizing the local installation of help topics and instead moving some or all help to Web servers. While this approach may alienate users who have no Internet connection or lack broadband access, there are many advantages. Web servers offer features and options that aren't available with locally installed help.
HelpScribe (2009). Articles>Documentation>Online>Help
#33635
Why Wikis Won't Kill Technical Writing
Many people have predicted that wikis will replace traditional help in the future. Ok, I can buy that. But I've also heard that technical writers will surrender content control to SMEs and users, and will move into other roles such as merely editing wiki content, or switching to programming, training. Sorry. I just can't see that happening. In the world of wikis, technical writers will still be kings of content.
HelpScribe (2008). Articles>Documentation>Technical Writing>Wikis
#33678
What's Your Technical Writing Personality Type?
Because personality has a strong influence on technical writing skills, it may help to take a look at how psychologists categorize personality types.
Haiss, Craig. HelpScribe (2009). Articles>Writing>Technical Writing
#33679
Every help authoring tool seems to have a different approach to presenting search results. Offerings range from ranked results to alphabetical lists, with additional features thrown in such as the inclusion of chunks of topic text with highlighted search keywords. Each method of presenting search results offers different benefits to users. Since help tools offer mixed approaches, I feel perfectly comfortable throwing my own opinions into the mix.
Haiss, Craig. HelpScribe (2009). Articles>Documentation>Search>Help
#33680
How Color Defines Purpose in User Assistance Content
Of all the visual cues in your help interface, color is one of the strongest. Users will recognize and react to the color of each element in your help window before reading a single word of text. Color allows users to determine the purpose of each element on the computer screen. When designing the visual aspect of your help content (via CSS and so on), as well as the help interface itself, be sure to use the same color for objects that share a purpose.
Haiss, Craig. HelpScribe (2009). Articles>Documentation>Technical Writing>Color
#33864
Off Site Reviews: Six Ways to Exchange Edits
Coordinating a document review can be a tedious process. However, the task is even more difficult when reviewers work in another location and can't quickly exchange comments via paper. Fortunately, technology is presenting writers with new options for handling off-site reviews.
HelpScribe (2009). Articles>Collaboration>Editing>Online
#34682
Writing user manuals isn't so difficult if you start with a clear understanding of the structure of such documents. This post will provide you with some guidelines for producing a great manual, and links to templates to help you get started.
HelpScribe (2009). Articles>Documentation>Technical Writing>Writing
