Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

User guide - how detailed?

 
Raf Szczypiorski
Ranch Hand
Posts: 383
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi. I am slowly getting close to being ready with the assignment. What is left is to do some GUI testing, write the user guide and package. My choices.txt is about 32kb, so pretty big and detailed. How big was your user guide in comparison? How much detaisl you put there? Do I need to write it so that my grandma can use the applicatoin, or can I assume an experienced user? Did you include screenshots (if you used html)?

Ragards,
Raf
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Raf,

choices.txt: 36 KB
userguide.txt: 16 KB (no screenshots)

I just explained how the application should be used, from the command you need to execute to run an application to every (business) exception that can occur with possible solutions. I didn't add how you have to start a dos prompt (on Windows) to execute the command. But if you have to click on a button in the application, that is of course mentioned in the user guide. I also have lots of white space (unlike the choices.txt file which is almost only text and very little white space) to increase readibility (because it is just plain text).

Hope it helps!
Kind regards,
Roel
 
Raf Szczypiorski
Ranch Hand
Posts: 383
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Wow 36kb, and I thought mine is long! Now i am getting nervous, I must make it longer!

Just joking. Thanks for the answer.

Raf
 
Martin Kolesar
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
My choices.txt was only 13kb and userguide 15kb (html file) + screenshots. I think images significantly add to the clarity of the text. I just explained how to start the application, how to perform basic actions - searching and booking, and described meaning of all buttons and other controls in the GUI. There is no need to go into deep details. From the point of view of a user I would be too lazy to read several pages of text in order to be able to work with the program
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic