Friday, November 13, 2009

Kaitlyn L's steps in writing a user manual

Having used and read many different user manuals I can say one of the best things is when it is easy understand. If it is a good user manual you will generally not want to kill the thing you are working on and/or yourself by the end of the project. So, since mostly everyone has read one before( and probably complained about them) we need to know how to put one together. Here are some basic things that help to make user manuals clear and useful.

1. Do NOT assume the user has done this before. This will help you to break things down and make it easy for whomever is using it.

2. Use step-by-step instructions and use visuals if needed to explain what is going on.

3. Include a table of contents so users have a way of quickly finding what they are looking for.

4. When writing a manual be sure to make an outline first. This will help you not to miss any steps.

5. Include a number or someway to reach you if they have any questions.

"Tips for writing user manuals." User experience consultancy & usability training from Userfocus. Web. 13 Nov. 2009. http://www.userfocus.co.uk/articles/usermanuals.html#Anchor-How-35882.

Possible Error Detected. Web. 13 Nov. 2009. .

Posted by at

4 comments:

  1. jdfernanNovember 15, 2009 at 9:04 AM

    Great tips on how to make user manuals clearer and more useful. I liked the paragraph above the tips. You put some of your own voice in it which is great! It is very true that if you do have a good manual, you will not want to kill the thing while doing it! I do not have any suggestions except for keep up the great work like you did for this blog.

    ReplyDelete
  2. Erin YarbroughNovember 15, 2009 at 9:24 AM

    I really liked your topic for this week. Before reading this post, I had never knew how to put a user manual together. Your steps are very clear, unlike some user manuals. I agree that you put your own voice in it. I do not have any suggestions etheir. You did a great job on this post!

    ReplyDelete
  3. ManiNovember 16, 2009 at 1:07 PM

    I think a lot of people don't know the first step (Do NOT assume the user has done this before). I missed it myself. Great post:-)

    ReplyDelete
  4. DanielNovember 16, 2009 at 5:08 PM

    I like this post a lot, I can get really frustrated when a manual is unclear. I like the tips, I didn't know how to construct a manual. Your steps are very clear and to the point. Great job on this post.

    ReplyDelete

Subscribe to: Post Comments (Atom)