aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Assumption Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Soft Skills this week in the Jobs Discussion forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Assumption" Watch "Assumption" New topic
Author

Assumption

XJ LIN
Greenhorn

Joined: Feb 05, 2002
Posts: 18
Some assumption must be documented. what is the best documentation to inclde assumption,
Readme.txt or DesignChoice.txt?
Thomas Fly
Ranch Hand

Joined: Sep 09, 2002
Posts: 164
You may want to look at SCJD Study Companion
I expect I'll be starting on documentation in another day or two (like anybody really documents as they go along...), but the above furnished me with templates named DesignChoices.html, HandBook.html, and UserDoc.html (there's no requirement to do the docs in HTML of course).
My intention is to put little more into readme.txt than "see DesignChoices.html," etc.
The names of the documents themselves should indicate what they contain- and where you should put a given bit of documentation.


Fly by Night Consultants<br /> <blockquote><font size="1" face="Verdana, Arial">quote:</font><hr><i>I climbed on the back of a giant albatross<br />which flew through a crack in the cloud<br />to a place where happiness reigned...<br />all year 'round<br />the music played ever so loudly!</i><p><a href="http://thomasfly.com/songs/Traffic/Hole_in_my_Shoe_qt.htm" target="_blank" rel="nofollow">Hole in My Shoe</a><hr></blockquote>
Michael Morris
Ranch Hand

Joined: Jan 30, 2002
Posts: 3451
Hi XJ,

Some assumption must be documented. what is the best documentation to inclde assumption,
Readme.txt or DesignChoice.txt?

I would say DesignChoice.txt. The purpose of Readme.txt is for installation and a high level "how to use".
Hope this helps,
Michael Morris


Any intelligent fool can make things bigger, more complex, and more violent. It takes a touch of genius - and a lot of courage - to move in the opposite direction. - Ernst F. Schumacher
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Assumption