Skip to main content

What's the best way of documenting agile code for developer succession planning

Last post 11:11 am March 16, 2016 by Jemer Garibay
3 replies
07:04 am March 14, 2016

We've adopted the SCRUM approach to agile development but one aspect we've not really addressed yet is how best to document the eventual code that is developed so that it can be picked up and supported and/or developed further by different resources.

As many will know, there's often a frequent turnover of resources in the software development world and as we grow as a business, we're having to use more and more temporary contractors.

How can we best document what we've developed so that someone new can pick it up and work with it quickly, as part of a Scrum team? All ideas and thoughts welcome.


08:49 pm March 14, 2016

It sounds as though the problem to solve isn't one of documentation, but team instability. Without stability, the team will find it hard to inspect and adapt, and to demonstrate and improve their professional competencies as a team at all. A high turnover may indeed be expected when people are viewed as resources and not as those professionals. Maybe that is one of the first things that needs to be changed.


05:40 am March 15, 2016

I fully agree to Mitchell, having stable teams should be the goal.


Anyway your question for me isn't specific related to agile or scrum as the challenge you describe would (almost) the same I guess even if your team(s) wouldn't do scrum. Nevertheless I have a suggestion for you: Do a retrospective and focus on exaclty this pain point. I guess your team will have good ideas or at least guide you in the right direction.


11:11 am March 16, 2016

Some ways to document your code

1. You can adopt a practice (or even add it as part of your DoD) that all codes are properly commented. Implement code review on every pull request and let at least one of the development team review it.

2. Each pull request should include a link or an ID to the story that is being developed. Multiple push should add which task made and/or which bug fixed.


By posting on our forums you are agreeing to our Terms of Use.

Please note that the first and last name from your Scrum.org member profile will be displayed next to any topic or comment you post on the forums. For privacy concerns, we cannot allow you to post email addresses. All user-submitted content on our Forums may be subject to deletion if it is found to be in violation of our Terms of Use. Scrum.org does not endorse user-submitted content or the content of links to any third-party websites.

Terms of Use

Scrum.org may, at its discretion, remove any post that it deems unsuitable for these forums. Unsuitable post content includes, but is not limited to, Scrum.org Professional-level assessment questions and answers, profanity, insults, racism or sexually explicit content. Using our forum as a platform for the marketing and solicitation of products or services is also prohibited. Forum members who post content deemed unsuitable by Scrum.org may have their access revoked at any time, without warning. Scrum.org may, but is not obliged to, monitor submissions.