Skip to main content

Refactoring a Demo

I love refactoring code. Moreover, I think refactoring can also be used when looking at software demos.

I love looking at a piece of code that works (for the most part) but just doesn't feel right and taking it apart and putting it back together so that it makes more sense, not just for me but for the next person who comes along.

I find it funny that refactoring and unit testing come from the same core concepts (Agile) because if done correctly, code that was properly unit tested SHOULD result in code that is pretty well-written and refactor-proof. (I'm no expert on the philosophies behind this so please comment and rip this post to shreds)

So refactoring really comes into places where you've got unwieldy code (or worse, legacy code) that no one really can wrap their head around. By the time you've finished refactoring, you possibly COULD have some ways of unit testing it (if you were able to separate each logical piece out).

So how does this apply to demos?

Depending on who is giving the demonstration, a demo will consist of the following:

a) overview of features
b) description of benefits
c) demonstration of functionality
d) explanation of functionality
e) review of benefits / explanation of results
and possibly
f) showing of additional features

The actual content differs by person:
If a sales person gives a demo, it likely goes a->b->e.
A sales engineer: a->c->f->b (possibly e)
A developer: a->c->f->d (and sometimes you don't even need a)
A trainer: a->d->c
A trained user: c

If you want to really look at a valuable demonstration, why not refactor each piece of the demonstration asking the following questions (in this order):

1. What benefit are you trying to show?
2. What feature showcases this benefit the best? *
3. What is the bare minimum I can show to highlight this feature?
4. Is the result obvious?

* If more than one feature gives this benefit "best", then you may want to rethink the design.

How does this relate to refactoring code? Re-ask the questions, thinking about code:

1. What is this block of code supposed to do?
2. How could I rename this to make it easier for others to understand?
3. Have I made this as simple a call as possible for this function to run?
4. Is the result obvious to the calling program?

Development and sales departments almost invariably have a love/hate relationship. Turning some of the questions that are asked in both groups around to match the other's parlance might make a love-fest possible.

Are there any other areas that might benefit from "refactoring"?

Comments

Popular posts from this blog

Who Wants To Be Logical? I Do! I Don't! (with Claude)

In my book, Towards Consciousness, I explore PET , a theory that attempts to explain consciousness and possibly how it might apply to AI. As part of the conversations with AI series, I've included this conversation with Claude.AI in which we were talking about something very different and yet the conversation redirected itself back to PET. For the record, there is no such thing as "Colfsity". A It's interesting to me that people want to proclaim their distinction from being rigid and unlike machines, yet they also complain that the "best" people keep a rigid schedule, regular routines and logic understanding of issues. That's a perceptive observation about a real tension in how people think about themselves and what they value. There does seem to be this paradox where rigidity is simultaneously rejected as "robotic" or inhuman, yet praised when it appears as discipline, consistency, or logical thinking. I think part of what's happening is t...

Merry Christmas

Whether you celebrate now, have already celebrated your past holiday, are planning to, or not, I hope you find yourself surrounded by family and those you love during this holiday season and are able to remember fondly those who are not with you. We often find ourselves buried in work, or too distracted by other problems, to share and remember a few moments with those closest to us. So many of us are separated by huge distances, we often find it easier to focus on those who are out of arm's reach yet so easy to connect with online, instead of those who are right beside us. So do yourself a favour, put down the keyboard (stylus, mouse, etc) and spend that time. I know I will. Merry Christmas. Powered by ScribeFire .

Comparing education systems based on their technology

(yes, I originally found this blog because of Scoble's note on it BUT it was kind of interesting all the same) Read Alex Mallet's summary of his first week at MIT. Malletrivia: Summary of the first complete week Wow - "There's an incredible amount of material packed into each lecture" - and it sounds interesting... Compared to some of the lecture content I have seen at our universities, you really must get what you pay for. While it sounds like Alex is writing frantically down notes in his classes, at least he's finding something worth writing about in them. Case in point: one of our local universities ( Carleton ) puts some lecture classes on the TV (like many universities do) - but you would think they purposely find the most boring professors to teach them. They put up PowerPoint slides with 30 points on them, speak in monotone voice (yes, imagine the typical caricature of the university lecture from years ago), tell the students to print their...