This week's book giveaways are in the Java EE and JavaScript forums.
We're giving away four copies each of The Java EE 7 Tutorial Volume 1 or Volume 2(winners choice) and jQuery UI in Action and have the authors on-line!
See this thread and this one for details.
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


Win a copy of The Java EE 7 Tutorial Volume 1 or Volume 2 this week in the Java EE forum
or jQuery UI in Action in the JavaScript forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "User Documentation" Watch "User Documentation" New topic
Author

User Documentation

Chandu onwards
Greenhorn

Joined: Dec 23, 2002
Posts: 13
Hi,
currently i have my user documentation present in the readme.txt file is this ok?, or do i need to supply a user documentation in a different file, if so plse let me know where do i need to specify the userDocumentation file name.
thanks,
onwards
[ January 03, 2003: Message edited by: Mark Spritzler ]
John Smith
Ranch Hand

Joined: Oct 08, 2001
Posts: 2937

currently i have my user documentation present in the readme.txt file is this ok?, or do i need to supply a user documentation in a different file, if so plse let me know where do i need to specify the userDocumentation file name.

Yes, user documentation must be in a separate file. Note that the contents and format of readme.txt is strictly specified, while user doc is up to you (including the name of that file).
Eugene.
Mark Spritzler
ranger
Sheriff

Joined: Feb 05, 2001
Posts: 17250
    
    6

I edited the topic title to be Proper Case. Having All Upper Case is like Yelling.
Mark


Perfect World Programming, LLC - Two Laptop Bag - Tube Organizer
How to Ask Questions the Smart Way FAQ
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: User Documentation