current community

your communities

more stack exchange communities

company blog
Stack Exchange Inbox Reputation and Badges
tour help
Software Engineering Stack Exchange is a question and answer site for professionals, academics, and students working within the systems development life cycle who care about creating, delivering, and maintaining software responsibly. Join them; it only takes a minute:

Sign up
Here's how it works:
  1. Anybody can ask a question
  2. Anybody can answer
  3. The best answers are voted up and rise to the top
up vote 2 down vote favorite

I have recently left my previous student job as a part time developer for at small ERP management firm.

During my time at the firm i have developed several modules for integration with the ERP system. Furthermore i have developed an application, and a backend for said application.

I have been asked to document the complex parts of my codebase, so that another developer might be able to take on further development.

Is there any best practice in handing over source code, how should i document, and to what extend should i document?

As a last note i have not been making any tests, or any documentation of the code, other than comments to help navigate the code structure. The product owner simply did not want me to spend time on those activities.

Any input is appreciated !

share|improve this question
1  
rather blatant duplicate of How do you go about training a replacement? – gnat Aug 31 at 13:07
2  
I dont see how. I am not going to train a replacement. I simply need suggestions for a process to document, as a new developer, who has never delivered source code which is in production. – BastianBuhrkall Aug 31 at 13:09
2  
"I have been asked to document the complex parts of my codebase, so that another developer might be able to take on further development." -- per my reading this is just about it. This doesn't generally assume that you sit and talk together, more often it goes as job handover checklist – gnat Aug 31 at 13:16
1  
@gnat This is not a duplicate of programmers.stackexchange.com/q/26349/4 since that question is focused on face-to-face training and education, while this question is focused on producing documents. It may be a duplicate of programmers.stackexchange.com/q/97758/4, but that question is closed (as a duplicate of a question that isn't actually a duplicate) and its answers are...distinctly lacking. – Thomas Owens♦ Aug 31 at 14:35
3  
Did I get this right? You already left, and now they want some documents from you, though before you left they told you not to write such documentation? And they did not even clearly tell you what they want, so you come here to this site and ask us? Honestly, is there a compelling reason why you are going to invest any effort into this (like payment, future job offer, testimonial)? – Doc Brown Aug 31 at 17:51

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Browse other questions tagged or ask your own question.