Help Authoring Software


  • No categories

RSS Feed Feeds


A great discussion about writing a useful user manual

Posted in: Help Authoring Software, Software for Writing User Manual by Edwin on April 20, 2011

Today I came across at Stackoverflow (a collaboratively edited question and answer site for programmers) a good discussion about how to write a user manual that’s useful, a lot of useful tips there!

Here are some really great points:

  • Think from the end user’s perspective – watching some one else using it (e.g. a  software)
  • make your manual all about the user, not the tool, focus on what problems your app is solving for the user in the first place and make sure that you follow through on showing them how to do that.

It’s worth reading! If you write user manuals, such as software manuals.


1 Comment
  1. Interesting idea! In a recent mentieg, I saw a Japanese colleague taking notes in Excel. My first thought was Odd! But then I saw that she has a system similar to what you’re describing (dates, notes, tags, etc.) for all kinds of notes related to her work. It seems to work well enough for her.I’m enjoying your blog!

    Comment by Deniz on December 2, 2015 at 10:04 pm