Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

URLyBird: questions regarding documentation

 
Daniel D. Guo
Ranch Hand
Posts: 30
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, Ranchers,

Per the assignment, we need to provide a javadoc document and user manual type of thing. Does this user manual need to explain how to use the application or the programs themselves or design decisions or them all?

I believe I finished the programs (trivial changes will never stop though), but found out there is still a lot of work in making the manual.

Sincerely,
Dan
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Dan,

I believe your user instructions should explain how to use the program. Your design decision document should go in a separate document.

Regards, Andrew
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic