>basic user documentation must be plain text
My assignment instructions says the "user documentation may be online if you wish, but there must be one file in the root directory of your submission called README".
Since the User
doc can be online, I'm going to assume that providing the user doc in HTML is acceptable (even though I don't plan on using the HTML for online help in my apps).
I have decided to provide the following:
1. README.TXT - which is in plain ASCII and contains details requested by my assignment's instructions.
2. javadoc with package-level docs
3. User Manuals in HTML
4. Design Doc in HTML
My source files contain a few javadoc comments related to design decisions, but only to help explain complex code. My HTML design doc is what I will expect the grader to use when evaluating my
project submission.