The mind is like a parachute. If it doesn't open, you're meat.

Dealing with cruft

18 Apr 2012

Working to enhance a software team’s productivity is a never ending task with a very vague goal.

It looks very bad on any burndown chart, task-based productivity report or velocity factor if you look at it on an individual basis.

Jon Udell posted an article with a sane viewpoint on the geek vs. others automation meme and I found the closing comment describes very nicely (part of) the role of a “productivity engineer”1:

In this view of the world, tasks that involve data manipulation (as so many modern chores do) are undertaken by teams. There is an infinite supply of manual chores. Everybody tackles them. Ideally there is one member of the team I call the toolsmith. Working shoulder to shoulder with the team, the toolsmith spots an opportunity to automate some piece of the work, writes some code, deploys it, observes how it gets used (or doesn’t get used), assesses its impact (or lack of impact), and then iterates on the code. Meanwhile the toolsmith keeps working alongside the team, chipping away at the never-ending and always-evolving list of manual chores, looking for more opportunities to automate, and exploiting them in an incremental and collaborative way.

There comes a point where the collection of automation utilities becomes cumbersome. Since currently I am deep in build systems and rake I see the same effect in the number of tasks that become available as we add automation steps and combinations of steps targeted at different workflows within our project (i.e. flashing the target when developing, debugging or testing).

In some cases you start thinking about objecttask hierarchies. In other cases things are superseded by newer functionality or the developers adopt a different/quicker/more productive workflow along the iterative process that is a software project.

In my own mind the system code just grows old. It can grow old with me - which just means I can read the code without retching and it will continue to work as wished - or grow old without me, in which case it becomes a grumpy, needy old man with a grudge and a cane to hit me with whenever I want to change something.

So how do you grow old in health and good spirits? You need exercise, regular checkups and some preventive medicine. ###As an example… Imagine a large build system built with rake. Something to the tune of ~8K lines of Ruby, with a lot of tasks controlling every aspect of software development from compiling and linking to document generation, documentation, release mechanics, metrics collection and automated testing.

Although not the traditional software example, such a system exhibits a compressed timeline of the code lifecycle especially where the build up of cruft and the speed with which parts of the code become obsolete are concerned so it serves really well for this article. And no it’s not just because that’s all I have been doing lately and I have nothing more interesting to talk about2.

###Exercise Code that does not run grows old really fast. The easiest way to keep up is to have tests. Without them large chunks of code fall into obscurity, things start breaking in tasks of “secondary importance” (i.e. documentation generation vs. system build).

100% test coverage is an ultimately useless effort but you do need enough so that most of your code gets exercised and you have to test all of the entry points to the system.

###Regular checkups So you have collected all this code but do you actually need it?

Collect usage metrics - which tasks are called, how often etc. There is a misconception that this needs to be done automatically and it sure is an efficient way but going around and interviewing your users/developers also works. It depends on your system.

Sometimes interviewing actually works better as you discover or point out new ways of doing things. Actual human communication goes a long way towards assuring that your software actually does what your users want it to do, which I guess is the whole point behind agile methodologies.

Visualization techniques are also very useful in uncovering forgotten corners, complex dependencies or optimization opportunities. Having a graph of tasks and dependencies works much better than staring at several pages of code. Then you can go around, paper in hand, and literally point and ask “do you actually use this?”3

###Preventive medicine Sometimes your checkups will uncover things that have been left to rot. The only way to deal with them is to take a scalpel to them.

Do not be afraid to throw away code!

Armed with the information your checkups provide, together with the tests, you should be confident enough to trim down the fat and keep that old code lean and healthy.

###Nothing new under the sun When expressing a metaphor on caring about and for your code I realize belatedly that I’m not saying anything about software development that has not been included in iterative, test driven - agile if you want - development practices.

But I’m talking about automation and development infrastructure, tools and scripts! The quick and dirty hacks you throw together so that you can then get on with the real work.

You’re going to have a very grumpy old man if you don’t treat your development environment as it should be treated: just like another software project

1I really hate the term. I wish I could find something that sounds cooler and conveys the role of a software engineer that enables his/her team to work faster, with greater efficiency and less hassle, bringing enjoyment into the workplace. Productivity engineer just conjures the image of a suited consultant gaming the numbers. Toolsmith is too narrow a term as you tend to work on process as much as tools.

2And I take offence at even the suggestion that such a system is not interesting/cutting edge/insert-cool-term-here.

3In Ruby the graph gem is a very useful resource and for rake systems that use less crazy dynamic task creation than mine it comes with a script to plot a graph of tasks off the shelf.

blog comments powered by Disqus