R – Looking for guidance on writing tutorials for users

user interface

We are developing a desktop application.We are writing tutorials for users in a wiki.I was looking for some guidance ..good practices when writing such tutorials.

regards

Best Answer

I think some basic rules are ok

  • include as many screenshots as you can
  • don't use too much technical wording
  • structure your pages/documents that it is easy to navigate inside
  • don't make the user looks stupid, i.e. way of writing that would say the user is not capable of doing anything

Also it could be a good idea if you make your wiki and ask one typical user to review it with you. Getting the opinion of the user would probably show you million of things you have forgotten.

Related Topic