Documentation authors rejoice! Your life just got a whole lot easier. With the current 2.8 beta you can now link directly to other lessons in your manual. ScreenSteps will automatically update these links so that they work in PDFs, HTML, Microsoft Word and ScreenSteps Live. This has been an oft requested feature and we think you are really going to love it. It is going to make modular documentation so much easier. The video below gives a quick overview.

You can download the latest beta here:

Download the 2.8 beta

We have also incorporated a lot of the feedback we have received about the new UI. There is still more work to do but we hope you are happy with how it is coming along.

Today’s software company, whether providing desktop or SAAS offerings, provides customer support in a number of different settings. For example, in our company we interact with our customers in five different ways:

• Email
• Forums
• Live on-line chat
• Twitter
• Telephone

All of these communication tools allow the person offering support to point customers to resources on the web that answer their questions. If your company has online help that is designed correctly then you will be able to leverage your materials in order to quickly answer customer questions.

Let’s look at five keys to making your online help documentation work for you when handling customer support requests.

1) Create short documents that demonstrate tasks

When you write your documentation you should show users how to perform tasks, not discuss features. For example, create a lesson that shows “How to configure an account” rather than “The account administration screen”. By creating short, task based documents you can point your customer directly to documentation that shows them how to do what they want to do. This removes the step translating the description of a feature into the necessary steps required to complete the task and reduces the amount of follow up questions.

Short, task-based lessons prove very helpful when providing support. When helping a customer in a support interaction you can string together multiple online help documents for the user to help them perform a larger task.

Look at the document titles in the image above. Notice how each title explains a task.

2) Make the URLs of each help document easily accessible

Whenever someone is viewing an article in your online help documentation they should be able to copy the URL from the browser address bar. If your online documentation delivery system uses frames that hide the actual URL or if you place multiple answers on a single page then you are making it more difficult to link to the content.

Customer support via Twitter pointing the user to specific document urls

3) Author content in a format that is easy to search

When looking for the relevant document to send to a customer you will probably need to search your documentation to get the URL. Make sure your documentation delivery system has search functionality that returns relevant results.

4) Use a publishing system that allows you to quickly add new content and update existing content

Documentation should be a process, not a project. Your documentation will need to be updated as new customer questions come in or your offering is updated. Whether or not your documentation keeps pace with these new needs will depend on how easy it is to update.

Make sure you use a publishing system that makes updating content as effortless as possible. If too much work is involved then your documentation will become stale as the more (seemingly) pressing matters of the day push documentation updates to the back of the line.

5) Create content in a format that is clear

It is important that you choose the proper format for your online help documentation. You don’t want your documentation to create more questions than it answers. Above all, your documentation needs to be easy to follow. We recommend using static screenshots and text as this provides the best balance of clarity, ability to search and ease with which you can keep your documentation up to date.

This documentation uses text and images to clearly outline the task to be performed

-

Your online help documentation can be a real asset for you regardless of which setting you are interacting with your customers in. By implementing these five keys to better online documentation you will get the most out of your documentation investment.

For an example of how we have implemented these keys in our own documentation take a look at our ScreenSteps manuals.

(more…)

This morning I read a post by Tom Johnson titled “If No One Reads the Manual, That’s Okay”. In it the author describes how he is writing a 200 page manual that no one will ever read and that somehow that is all right.

That no one will read a 200 page manual is perfectly OK. That people are still writing them is insane.

In the comments of the post, some technical writers were making the case that users needed to read the manual. But it doesn’t matter what you think users should do, only what they will do. The real problem here is that technical writers keep doing the same thing and expecting different results (the definition of insanity).

Here’s a suggestion, instead of talking about how people should use the content you create start trying to figure out why they aren’t using it.

And then fix it.

Don’t accept things the way they are.

Make your content useful and make it accessible when and where the user needs it.

Here are some questions to ask yourself (these all relate specifically to software manuals):

What happens when a user doesn’t read the manual? One of the things they do is contact support. Develop and deliver your documentation in a way that can be used in a support situation.

What are your users asking? Are they asking “Could I please have an overview of the Upload tab?” or “How do I upload a file?” Is your documentation structured around the questions your users have or the way your application is organized? Which would your user prefer? Which would be most useful to your users and your organization?

Where do users ask questions? They call, email, post to message boards and use Twitter. Can you deliver the content your users need (your manual) in the places where they are asking the questions?

These are the questions technical writers need to be asking themselves if they want to move beyond just fulfilling requirements to really adding value to their organizations.

Several months ago we recorded a webinar on this exact subject called Why Your Documentation Stinks and How to Fix It. Check it out if you want some new ideas on how to get people to read the documentation you write.

The other day I was watching my 5-year old complete a connect-the-dots page. I was amazed at how such a simple concept could turn just about anyone into a semi-functional artist. All he had to do was draw one line at a time between two numbers. At the end he had completed a drawing that would have been far beyond his ability had the dots not been there.

This is exactly how your documentation should be. Software is not art. It isn’t golf. It isn’t the violin. You shouldn’t need to work years and years to master it. There is a task. It needs to be done. People are going to use your software to do it. Does your documentation allow them to connect the dots?

Now imagine if my 5-year old sat down and saw “1,2,3,4,29″. Imagine that between 4 and 29 there are bunch of dots with no numbers on them. What would he do? He would be extremely frustrated. Which dot does he go to next?

You can find these “missing numbers” in documentation all of the time and it creates feelings of extreme angst and frustration – not exactly the experience you are trying to create for your users.

This happens most often when documentation focuses on features and not tasks. Are you telling your user what your program does or are you telling them how to do it?

Next time you are documenting something, ask yourself, am I numbering all of the dots? Are my users going to be able to connect those dots? If not then go back and tidy things up. Your users with thank you for it.

I don’t ever plan my documentation. I used to. But not anymore. It’s a waste of time. Maybe if I were on a documentation team and had 6 months to get the documentation ready then maybe I would plan. I could plan and then revise and then plan some more.

But I am not on a documentation team. I run a business. I am the web programmer, accountant, custodian, sales person, system admin and business development director. I don’t have time to plan my documentation.

So what have I done? I have planned not to plan. I have created a system for documentation that requires no planning at all AND creates documentation that is much more useful to our customers. It really is quite simple. Just follow these simple steps:

1. I write down the questions my customers have actually asked me.
2. I create lessons in ScreenSteps that answer those questions.
3. I post the answers as a manual to ScreenSteps Live. You can see an example here.
4. When a customer asks a question I do one of two things:

- If I have a lesson that answers their question I send it to them. - If I don’t, I create one, add it to the manual and send it to them. See here and here for two lessons I added to our manual this last week in response to customer questions.

This system has worked really well for me. I don’t end up writing content that won’t ever get used again, the lessons are very easy to update because they focus around a specifc task and I can quickly respond to customer questions.

Try it out. On your next documentation project, plan not to plan. Just answer the questions people are asking. You will find that your documentation will be easier to create and easier to use.

We get a lot of questions about what ScreenSteps Live is. Here are some examples:

“Is it .Mac for ScreenSteps Lessons?”

No.

“Is it just a file sharing service?”

No.

“Is it a blog for ScreenSteps Lessons?”

No. But we did say that once which was a bad marketing move on our part – completely the wrong category to put ScreenSteps Live in.

And our favorite:

“Why would I need ScreenSteps Live when I can already export lessons as HTML or post them to my blog?”

The answer to that takes just under 5 minutes and can be seen in the video below.

Over the weekend we posted some updates to ScreenSteps Live. This is the start to a slightly different direction for ScreenSteps Live so we wanted to let you know what we have been doing and where we are going.

When ScreenSteps Live was originally launched it was really just a place to post ScreenSteps lessons. It was somewhat like a blog for ScreenSteps lessons.

The problem we found for our customers, and for ourselves, was that we didn’t want to have yet “another” blog for tutorials. So we really didn’t end up using ScreenSteps Live that way. ScreenSteps Live for us, and for many of our customers, became a place to support users by creating online manuals. But not a place to just occasionally post lessons.

We could see this in our customer usage. Our customers that were using ScreenSteps Live as a customer support tool were posting a lot of lessons and posting very regularly. Those who were just using it as a kind of blog only posted occasionally.

With this realization we have made a few changes to ScreenSteps Live. I don’t want to say that we are relaunching ScreenSteps Live but we are definitely heading in a slightly different direction.

Quick List of Changes

Here is a quick list of the changes launched this weekend:

1. No more front page lessons – There are no longer lessons available at the main screenstepslive.com site. If users want to see your lessons then they must specifically go to your account. For example, ours is bmls.screenstepslive.com.
2. Embed full manuals into your website – You can now embed the table of contents for a complete manual into your own website or web app. Just copy some javascript code and insert it into your web page. The table of contents will appear on your own web page and will update each time you change your manual on ScreenSteps Live. This gives you the benefit of the ease of use of ScreenSteps Live while still having the manual table of contents appear on your site. Once the user clicks on a link in your manual they will be taken to the lesson on ScreenSteps Live. Here is a lesson on how to do it: Embedding Manuals.
3. Updated Plans – The available plans have changed slightly. The main change has come to the free plan. Before the free plan was just a place to post ScreenSteps Live lessons. If that is all you want to do then we really suggest that you use ScreenSteps 2.1 with a blog service such as WordPress or TypePad. The new free plan is really a chance for you to try out the features available on ScreenSteps Live for customer support.

If you already have a free plan nothing will change for you. You still have the same plan that you had before. The updated free plans only affect new users of ScreenSteps Live.

A More Detailed Look At The Changes and Where ScreenSteps Live is Going

(more…)