Forums Register Login

what should I tell the accessor in my document

+Pie Number of slices to send: Send
Hi,
In order to submit the assignment, we have to write readme, decison document, design document, user manual.
I am wondering :
1) Do I forget other documents that I should write ?
2) Do I need to tell the accessor how to compile,
how to jar the classes , where is the database file ?
3) Do I need to show the class diagram, sequence diagram ... etc ?
4) readme is a plain text file. Which document should be written in html format ?
5) What do I do with the man pages (Javadoc compiled result) ?
Thanks,
John Chien
+Pie Number of slices to send: Send
1. I think you have all the documents there.
2. No, do not have the assessor compile, you submission should be ready to run from the jar files. The requirements specifically state that the Assessor should not have to compile your code.
3. That is up to you. It would be in the design.txt file if you do. I myself made a simple text based class diagram, but it isn't necessary.
4. The user documentation is usually in HTML and accessible from a Help menu in your app.
5. You also submit your JavaDocs. I kept mine in the same locations as where they show up after creation, but you can split it up into a doc directory if you wish. It is up to you. But of course they should be accessible to the Assessor from your directories, and that the links within them work.
Mark
+Pie Number of slices to send: Send
Mark:
Thanks.
John Chien
My pie came with a little toothpic holding up this tiny ad:
a bit of art, as a gift, the permaculture playing cards
https://gardener-gift.com


reply
reply
This thread has been viewed 460 times.
Similar Threads
README not required in the beta?
need help (about documentation)
submitting the assignment
Packaging of files
Design Documents Format
More...

All times above are in ranch (not your local) time.
The current ranch time is
Mar 28, 2024 10:59:52.