It's not a secret anymore!
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes What is user document Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "What is user document" Watch "What is user document" New topic

What is user document

Xihang Liu

Joined: Aug 28, 2001
Posts: 3
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?
Ricardo Polero
Ranch Hand

Joined: May 18, 2001
Posts: 128
Hi, I have the same doubt !
Peter den Haan
Ranch Hand

Joined: Apr 20, 2000
Posts: 3252
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
I agree. Here's the link:
subject: What is user document
It's not a secret anymore!