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

Elevating Project Specifications with Three Insightful ChatGPT Prompts

For developers and testers, ChatGPT, the freely accessible tool from OpenAI, is game-changing. If you want to learn a new programming language, ask for samples or have it convert your existing code. This can be done in Visual Studio Code (using GitHub CoPilot) or directly in the ChatGPT app or web site.  If you’re a tester, ChatGPT can write a test spec or actual test code (if you use Jest or Cypress) based on existing code, copied and pasted into the input area. But ChatGPT can be of huge value for analysts (whether system or business) who need to validate their needs. There’s often a disconnect between developers and analysts. Analysts complain that developers don’t build what they asked for or ask too many questions. Developers complain that analysts haven’t thought of obvious things. In these situations, ChatGPT can be a great intermediary. At its worst, it forces you to think about and then discount obvious issues. At best, it clarifies the needs into documented requirements. ...

Blogs and RSS come to Microsoft.com

MS has just introduced their portal and it's pretty comprehensive. Nothing quite like learning that some people use AIM instead of MSN messenger, or that there really may be a need for supporting 4 monitors ( Cyrus Complains ) However, it's really a great sign that MS is serious about supporting the blogging community which seems to have um, exploded in size in the past year. Blogs and RSS come to Microsoft.com

I’m Supposed to Know

https://programmingzen.com/im-supposed-to-know/ Great post for developers who are struggling with unrealistic expectations of what they should know and what they shouldn't. Thirty-forty years ago, it was possible to know a lot about a certain environment - that environment was MS-DOS (for non Mac/UNIX systems). . There was pretty much only a handful of ways to get things going. Enter networking. That added a new wrinkle to how systems worked. Networks back then were finicky. One of my first jobs was working on a 3COM + LAN and it then migrated to LAN Manager. Enter Windows or the graphical user interface. The best depiction of the complexity Windows (OS/2, Windows NT, etc) introduced that I recall was by Charles Petzold (if memory serves) at a local user group meeting. He invited a bunch of people on the stage and then acted as the Windows "Colonel", a nice play on kernel. Each person had a role but to complete their job they always had to pass things back to h...