Help as an emotional conversation

I was re-reading the Cluetrain Manifesto today. The following item hit a nerve.

"3. Conversations among human beings sound human. They are conducted in a human voice."

Maybe that's why user assistance sometimes increases frustration. Help isn't conversational.

Trying to teach people how computers communicate isn't very helpful. Sure, people can learn help conventions and adapt to our help interface. But should we expect them to work at it at exactly the moment when their frustration level is highest?

I don't learn well when I'm frustrated.

H-E-L-P is an emotionally-packed word.

Real human conversation is sensitive to frustration and other emotions. The voice of help should be that of the hostage negotiator or the crisis hotline expert. Help should say "Hey, you look really frustrated, but I think I can help. What's bothering you?"

Perhaps help should even let users vent a bit.

"Use the field below to blow off steam. Then, tell us what the problem is. We'll try to offer some advice, and adjust the brevity and directness of the response based on the number of offensive words in your query."

In human conversation, sometimes the other person simply doesn't have the answers we seek. But there's something about talking to a human being in an emotionally-expressive way that calms us down and puts us in a better state of mind for solving the problem.

Often, we can figure out the answer for ourselves, as soon as we calm down and think it through.

Help lacks that sympathetic voice. It doesn't know how to calm us down.

Related: Technical writing and consumer emotion.

Policy and procedures manual template | Writing guide

Here are some templates and tips to guide you through the process of writing a policy and procedure manual. Such documentation is very important if you want your business to operate efficiently. It will help reduce managerial stress and possible legal conflicts, and ensure that your employees know how to perform their jobs according to expectations.

Templates

To work efficiently, first download a policy and procedures manual template so that you don't have to start from scratch. (You can find professional "Policy Manual", "Standard Operating Procedures", and "Employee Handbook" templates via the link below.)

You can Download templates here >>

Tips

The value of standard operating procedures is that they ensure consistency; when employees do their jobs according to an proven process, the result is greater productivity. These tips for writing standard operating procedures will help guide you through the process.

  • Communication is essential when writing such a manual. You must have the cooperation of managers and executives to guarantee that company policies are accurate and that all necessary guidelines are included.
  • Involve as many employees as possible in the process of developing the standard operating procedures. While the writing process should be coordinated by one person, allowing others to contribute will help them see the process as a vested interest, and they will be more likely to comply.
  • Focus on documenting procedures for tasks that are critical. Does the process involve risk? If so, documenting that task helps reduce the risk. Is the process complicated, and does the business rely on the outcome? If so, documenting the task will help the business reach its goals.
  • Is the resulting guide well organized? Adding navigation tools will make it useful as a reference tool when employees get rusty on the details and need to look something up.
  • Are all important steps of each procedure outlined, and then described in a detailed, orderly fashion? Check out these tips for writing effective procedures.

Numbering

Policies and procedures usually follow a numbered format for easy reference. Both main sections and subsections are numbered, Subsections use a decimal format. For example...

1 Main section 1

1.1 Subsection 1

1.2 Subsection 2

2 Main section 2

2.1 Subsection 1

Descriptive headings

The headings for each section should clearly summarize the procedure or policy it describes. Such a structure is intuitive for readers searching for a particular policy. For example, if your reader is seeking information on your company's policy for using computer workstations, the section heading should probably read "Using computer workstations," or something similar.

Subsections should also have clear headings. For example, the "Using computer workstations" section may contain subsections called "Installing software" and "Downloading files."

By using headings to outline your guide before writing, you can ensure that all appropriate policies and procedures have been covered.

Definitions

A clear standard operating procedures format will include a glossary defining terms that may be unfamiliar to readers.

Definitions are usually formatted so that the glossary term is bold, with the definition in roman text. The bold font allows readers to quickly scan a list of definitions for the term they are looking for.

You can put the glossary section at the end of your manual, or put a numbered definition subsection in each section of the guide, as needed. If you put it at the end, be sure to include a reference or table of contents at the beginning that indicates the presense of the glossary. If you put the definitions within the policies, be sure to include only definitions that are relevant to that policy or procedure.

Enforcing compliance

You may wish to include information to help enforce your policies and procedures. For example, consider adding a description of the consequences of violating a policy. That way you can ensure readers are aware of the consequences ahead of time.

Also, many policy and procedure formats include a section at the end for the reader to sign and date, serving as proof that they have read and agreed to the information contained in the document.

Resources

Now, review the following resources for details on writing policies and procedures that will provide clear guidance to employees.

Be sure to keep your manual up to date by reviewing it often. Your business will operate with greater efficiency and your employees will have a stronger sense of purpose.

What users want from help content

Research has shown that most users have short attention spans when viewing help. If they don't find what they are looking for, or if they don't recognize it when they do find it, they will give up and seek help elsewhere (Google, Customer Support, etc.). Each time they give up, their overall trust in the help decreases.

So how can we create help content that improves trust?

By giving them exactly what they want, and no more.

By "no more" I mean separating reference material from procedures and FAQs, and providing information in a granular way. Readers are easily overwhelmed. If you give them too much information, they will struggle to find the specific information they seek.

Here are some suggestions for providing users with exactly the information they need.

  • Use FAQs heavily. The question-based titles allow users to quickly determine whether an FAQ will meet their needs. Use search data when writing the question-based titles so that they are worded in the same manner that users ask the questions.
  • Move overview content into separate topics, and into a printed manual. Overview information is more linear than procedures. By putting such information in a manual, you allow interested users to read that content in a more user-friendly manner. Also, you avoid cluttering the help with background information that experienced users won't need.
  • Build embedded help, if possible, or use F1 functionality to tie context-sensitive topics to the interface. That way users can quickly find information relevant to the task they wish to perform.
  • Take advantage of the navigation features in your authoring tools. For example, RoboHelp now offers keyword-based search. If you implement this feature, users will be able to find relevant topics even if their search keywords do not appear in the topic.
  • Provide options. If users access the help in a manner that doesn't provide context, present them with a list of options that will narrow down their content needs. For example, your Welcome topic might include the following four links: FAQs, Procedures, Overviews, Tutorials.
  • Gather feedback whenever possible. Take advantage of user forums, usability testing, and other forms of information so that you can improve the help based on real usage data.

Remember, the primary job of a technical writer is to act as a user advocate. If you stay focused on that goal, your efforts will result in highly useful help content.

See also: How help search should work.