Documenting code when leaving a company [closed]

Question

I resigned from my current place of work yesterday, and I'm taking it upon myself to document my projects so I can hand them over easily.

Bearing in mind that my code is already commented to a good standard, what else should I put together to help my fellow developers take over my projects?

Answer 1

When working with a new code written by someone else, the first thing that the new guy (or girl) lacks is an overview over the System. What subsystems are there, what's their purpose and where should one look to accomplish a given task at hand are some questions that come to mind.

A concise starting document, explaining the overall system design (and the reasons why this design was chosen) perhaps with some diagrams, would be something I would be really glad to get when working on a piece of software written by someone else.

Answer 2

Consider making your top-level overview documentation a Wiki - it allows your soon-to-be ex-colleagues to edit and expand it easily.

And a rationale (as mentioned) is very useful: Why did you choose solution A, when solutions B and C look so much better to a casual observer? It can nip all kinds of endless discussions in the bud.