This week's book giveaway is in the Java 9 forum.
We're giving away four copies of Java 9 Modularity: Patterns and Practices for Developing Maintainable Applications and have Sander Mak & Paul Bakker on-line!
See this thread for details.
Win a copy of Java 9 Modularity: Patterns and Practices for Developing Maintainable Applications this week in the Java 9 forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

Assumption  RSS feed

 
XJ LIN
Greenhorn
Posts: 18
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Some assumption must be documented. what is the best documentation to inclde assumption,
Readme.txt or DesignChoice.txt?
 
Thomas Fly
Ranch Hand
Posts: 164
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!