• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

What is user document

 
Xihang Liu
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello:
One of the deliverable is "to provide user documentation for the database server and the gui client."
My questions are:
Is it same as README?(Doe not look like).
If it is not, what should be documented in this file?
What needs to be explained about database server and gui client?
Could someone give me some hint?
Thanks
 
Ricardo Polero
Ranch Hand
Posts: 128
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, I have the same doubt !
 
Peter den Haan
author
Ranch Hand
Posts: 3252
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The way I personally interpreted it is that you need to provide a small user manual. So I asked myself: what does a user need to do? Start the application, search for flights, and book them. So that's what the user manual covered, with a couple of screenshots and a simple user-level explanation how to perform each action. I wrote the manual in HTML and added a help menu item to the application that calls up a window with the manual.
- Peter
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic