aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes User documentation 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 "User documentation" Watch "User documentation" New topic
Author

User documentation

Liviu Carausu
Ranch Hand

Joined: Oct 07, 2004
Posts: 158
Hi everybody,

I quote from my specifications :

You must provide basic user documentation. This should be sufficient to allow a user who is familiar with the broad purpose of the project to use the application.
This documentation must be in one of these three formats:
* HTML
* Plain text (not a wordprocessor format)
* Within the application as a help system.


What is the catch here ? Do you think that I lose points if I deliver the user documentation only as HTML ?

Thanks,
Liviu


Oracle Certified Master Java SE6 Developer(SCJD),
OCE JEE 6 JSP and Servlets Developer.
Roberto Perillo
Bartender

Joined: Dec 28, 2007
Posts: 2268
    
    3

Howdy, Liviu!

Do you think that I lose points if I deliver the user documentation only as HTML ?


No. You have to choose one of the 3 ways to provide instructions to your users. This is the user guide, so if you provide instructions about how to use the application you developed, it should be ok. I chose to create only a plain text user guide, but the main point is to provide instructions about how to use your application in this document.


Cheers, Bob "John Lennon" Perillo
SCJP, SCWCD, SCJD, SCBCD - Daileon: A Tool for Enabling Domain Annotations
Liviu Carausu
Ranch Hand

Joined: Oct 07, 2004
Posts: 158
Roberto Perillo wrote:
No. You have to choose one of the 3 ways to provide instructions to your users. This is the user guide, so if you provide instructions about how to use the application you developed, it should be ok. I chose to create only a plain text user guide, but the main point is to provide instructions about how to use your application in this document.


Hi Bob,
Thank you very much for your answer. I can spare some time by not making the help system.
Liviu.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: User documentation