Explaining how the code you wrote works

Question

I was asked to create for a freelance project a Monopoly game in Java. After finishing it the same guy asked me to create four UML diagrams from which he could understand how the game works. Everything went well this far but his third request presented me with some problems.

He now wants me to write for him in about 20-25 pages, how the game's code works, so he can understand it. I have been programming for about a year and I was never asked to do this before. I don't even know where to start to do this, from which portion of the code should I start to explain it? I basically suck at writing.

Is there any guide that could help me achive what I need? I've already created the use case diagram sequence diagram, class diagram and activity diagram.

score 2 · Accepted Answer · edited May 23 '17 at 12:40

2

I guess that what your client asked you is the Software design document. You can find some guides here, here and here.

A related question is https://stackoverflow.com/questions/708624/what-should-a-good-technical-design-document-contain

edited May 23 '17 at 12:40

Community

1

answered Apr 28 '12 at 12:45

Vitaly Olegovitch

1,368

score 0 · Answer 2 · answered Apr 29 '12 at 01:14

Diagrams that you have created would verify the business logic, but this is something that they already know, so I would question a need for these diagrams.
If they are paying for your time and you feel that you can explain your work in 25 pages, then do it.
You could ask them to debug code and make a list of questions for you.
You could also spend a day with them explaining what you have done.

Explaining how the code you wrote works

2 Answers2