What is an example of user documentation??

Question

Hi,

I'm writing this Rational number class for one of my cs courses, using C++. We're also asked to hand in a "user documentation", which is sth that i've never done before. What is an example of user documentation? what is the format of it? Thanks!

Answer 1

Try Doxygen. It will dynamically generate some of the documentation. For an examle, look at http://www.boost.org/doc/libs/1%5F40%5F0

Answer 2

"User Documentation" is written instructions you would give to someone using your software. In other words, write something that tells your end user, in this case your instructor, how to run your program.

Take a look at doxygen for a way to turn your code's comments into html user documentation.

Answer 3

You should ask your instructor to clarify what he/she is asking for - that is what a good engineer would do...make sure to nail down the problem with the customer :)

User docs could mean:

• Source code docs (user is another program)
• README.txt file
• End-user doc in HTML, CHM, whatever

Answer 4

Take it simple... use this snippet before methods replacing wherever necessary:

//**************************************************************
// Output condition over the program after method execution
// Input variables, their type and meanings
// Return value
//**************************************************************

You should see Java API to notice how a documentation should be...