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

what should I tell the accessor in my document

 
John Chien
Ranch Hand
Posts: 105
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
John Chien
Ranch Hand
Posts: 105
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Mark:
Thanks.
John Chien
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic