• Post Reply Bookmark Topic Watch Topic
  • New Topic

Documentation

 
Daryl Fong
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have completed the assignment 6 months ago but have not submitted it yet. The reason I am a bit confused on the documentation part.
Can anyone please guide me through like how much to document and what are the main topics.
My gut feelings for the topics are:
1. Installation and running the programs.
2. Design overview
3. Design considerations.
and it would be around 2500 - 3000 words.
BTW, do you need to supply javadoc and help ?
 
Mark Spritzler
ranger
Sheriff
Posts: 17309
11
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes. To all that you wrote. My design.txt file was about five pages long. But as you could see from most of my posts, I tend to be wordy.
If you read the instructions.html file that came with the assignment you can see the minimum information you need to put in your readme.txt and design.txt
You must also have all the Javadoc for all of your classes.
If you already have the javadoc stuff in your code, you can run the following, replaceing my package names with yours.

Good Luck.
Mark
 
Happiness is not a goal ... it's a by-product of a life well lived - Eleanor Roosevelt. Tiny ad:
the new thread boost feature: great for the advertiser and smooth for the coderanch user
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!