Help Authoring Software

Categories

  • No categories

RSS Feed Feeds

SEARCH

Tags

academic writing beta release beta test Corkboard corkboard software document backup export documents Hierarchy Index cards index card software large word document long word documents mind map Note cards note card software Outliner Outliner for academic writing outliner for writers Outliner Software outliner software for Windows outliner software for Word post-it scrivener for pc scrivener for windows software for writer sticky card software sticky notes sticky notes software tabbed editing tag word documents technical writing Tree structure Tree view word 2010 word add-in Word addin Word addon Word document full text search word document manager Word document search word document tagging writer's software write user manual writing a book in Word writing a novel

Archives

RSS Latest Forum Posts – General Discussion

RSS Latest Forum Posts – Beta Test Discussion

Recent Comments

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.

Comments

1 Comment
  1. Deniz

    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