Report on Java Assignment

KERSPLAT!

So I've an end of year project just about finished and I've to write a report on it. I'm just wondering what goes into a report on a program? Do I just go through the methods, classes, etc. that I've used and why I used them? I've never written a report for programming so I'm at a bit of a loss and just want to make sure I hand up the right thing

Cheers

GreenWolfe

If you followed a specific development methodology (TDD, Agile, etc) it might be worth talking about that in your report. If you haven't, don't - it will end badly. So if you mention that you employed agile techniques, you'd better have evidence ready (burndown charts, sprint records etc).

Similarly if you mentioned that you used TDD, make sure you have a full suite of test cases ready, and be able to describe what happened if you found your initial test cases to be inadequate or incorrect etc. Once again, only mention the stuff you can defend under questioning.

Also, if you've used a technology not covered in your course (i.e. a functional language) you may be able to have a discussion on its benefits compared to a more standard approach.

It should be OK to include a user manual with screenshots in your report as well. If you're not sure about what or what not to include, an email to your supervisor is the only way forward.

RealistSpy

You can look at my final year software development documents.
NB: I use the Agile methodology.

http://vla.azurewebsites.net/Development.aspx