The bug reporting mechanism

As all developers know, even the best of us leaves bugs here and there. I guess it comes with the package.
One of my teachers said that it was all a matter of probabilities : coding complex routines and structures gets exponentially difficult as the size grows, and therefore produces statistically more bugs. QED.

Most of us, when we start, think we produce bug-free software. The program is too small, the users are too few too even notice, and even if there are bugs, they are peripheral at best. So we just ship out the product and drift happily back to another project.

And the bug report hits us. It can be:

  • A bad review, online (cowards!)
  • A friend saying “you must have noticed this, that’s why I didn’t report it during the beta testing phase. Why did you even ship it?” (that’s what beta testing is about, dammit! I don’t see the same problems you guys see!)
  • An email stating the program crashes/loses data/does something really dreadful, without any detail (I know a bug sucks. I want to fix it too. Please help me!)
  • An email by a fellow developer, or a power-user, who actually details everything, including the crash log, along with some suggestions on the way to fix it (most of the times, this is very useful, but can be ill-perceived, depending on how condescending the tone feels)

Apart from the last one, the real problem lies in the “shyness” (let’s say) of the people reporting bugs : either they don’t want to be confrontational, or they think the bug is not a real issue, or they just assume someone else will report it. In my book, it’s a cultural thing. People would like to help, but they assume the worst.

We developers are not monsters, we don’t prey on poor users unable to defend themselves. Most of us aren’t even real geeks, incapable of interacting socially with our fellow human brothers. We just talk a different language. And we are used to interacting with a very very stupid entity : the computer.

As such, we need a way to allow non-technical people to grant us the benefit of their help that is as simple as possible for them, and as complete as possible for us. If there are technical guys reading, please bear in mind that explaining that is something that can also be interesting for you.

What do we need to make a good bug report?

  • A nice submission mechanism (email, web interface, crash reporter, …). The best ones are those that leave a trace
  • The setup of the machine. No need to go in deep details, just what’s relevant : OS version, computer model, and potential third-party upgrades
  • The actions that triggered the bug. If it’s repeatable (meaning “it doesn’t occur just once, I saw it several times in similar circumstances”), it feels really good to have a simple way to crash “on demand”
  • If possible, the crash log

When we have all these items, we are in debugging heaven. On small scale projects, emails are just fine. Even if you get 10 bug reports a week, you probably have a lot of duplicates. And here lies one of the major objections to bug reporting : “the developer must know already”. Well… probably not. And even if I do, it makes me feel this particular bug is more important than another. But it is a very good help to actually have a list of reported bugs somewhere accessible. That way people can look there to see if a report matters or not.

Personnally, I use RT ( from Best Practical ), for one reason : it is fully cross-aware between emails and web interface. When you modify something in the web view, it sends out emails, and when you send emails, it updates the web interface accordingly. It has all the gimmicks you want to use, such as severity and such, but it’s still pretty simple on-screen. It’s better not to frighten non-technical users with a flurry of options and popups.

Why did I ramble about bug reports exactly? Well, yesterday, I received a response to a bug I reported… in March 2005. Having a good bug reporting mechanism helps you keeping track of the time spent on bugs, and (if you are stubborn enough) it can nag you every so often to keep you from forgetting the “old ones”.


First class of the year

Here we go for another year full of students! The two topics for the 2006-2007 sessions are Object Programming Techniques in Java, and Embedded programming, in Java as well.

My first batch of students are in their last year (the french system is fairly complicated for foreigners, but basically, we are supposed to go through the high-school end exam – called the Bac – at 18, and we count from the aforesaid Bac on), Bac+5 level. They are specialized in embedded systems, with a good electronics background. The aim of this session is to make them understand that on top of hardware, there usually is software, and that embedded means… well constraits.

They were shocked, awed, and a little afraid, to learn that this class is taught in english. My english is fairly good, I hope, but french people tend to get shy very quickly with foreign languages. From school, we learn grammar, not how to talk… So if you english-speaking people out there ever visit France, don’t be surprised at the reluctance. It’s not they don’t want to talk, it’s just that they feel out of their depth with english. Talk with the hands, if need arises :D

So, 2h of Java later, they seemed okay. No one had fallen asleep, and I can’t say I had seen a lot of people doing crosswords. Either I am getting lousier at spotting slackers, or I actually get less every year!

Embedded Java is not the funniest thing to do in the best of times, so I can understand that these classes that range from highly abstract to awfullly pragmatic can be a little disappointing. It will get better once we get to the hands-on sessions, I promise!


Apple Expo ’06

Being a freelance developer is all about people. Pleople you work with, people you would like to work with, people who are using your products, etc…

Social networking becomes very important in my line of work. Clients contact me from mouth-to-ear, because they know someone who worked with me, or people who have used one of my small programs. I don’t remember ever having to actually prospect for customers, because a) I don’t have the credibility (I’m young, but I worked on a lot of projects. Nope, I can’t talk about them, most of them are still under NDA. Please, believe me!) and b) it’s very hard to tell someone he actually needs you, especially if you don’t have any idea why he would need your help.

So it is without any surprise that I accepted to help out for the big french “mass of Apple” – a.k.a. Apple Expo, on the “Business & Innovation” booth. Helping people I know is both immensely satisfying as a human being (I’m nice, right?), and as a professional developer (who’s the guy sitting there? really? cool, let’s chat!).

As usual, I’m part of a very small team, doing a very unspecialized job : we handle the Problems. From network access all the way to stool-theft (no kidding!), the four of us got to handle the well-being of our fellow professionals, making contacts and being as unobtrusive and efficient as possible. This year was comparatively easier than the previous shows, partly because being a mac developer (as opposed to being an iPod-something) isn’t as image-rewarding as it used to be – so we have to stick together -, partly because the general public was not as interested as before, prefering to drift towards the loud speakers.

So we spent a week together as professionals having a good time in a not so pro environment. The business was attented to when the general public was still waiting for the week-end, and for the last couple of days, all that was left to do was preventing people from entering the bar (Sorry, it’s a private lounge. No there’s no open-bar lounge on the show floor. Yes, I will prevent you from entering if the need arises), trying to keep people away from the exhibitor’s computers (Sorry this is not a cybercafe. No it’s not an empty post, the guy will be there shortly, to work. Yes, I’m a mean guy, because you can’t play online chess on this computer) and drinking coffee (to cope with the tiring activity).

I took the liberty of shooting a few pictures, starting with The Before Crew,

then The During Crew

PG & HGNoarMS & Ju'Yann

All in all, it was a success on all fronts. Thanks to everyone who attended!


[UPDATE] Yann has posted his own impressions


Highlight 1.0

Sometimes, someone asks me if an application for doing such and such actually exists. If it doesn’t, then they taunt me into making it.

This is the case with Highlight. Arnaud contacted me, asking if I had any on-screen drawin application, a simple one, just to make demos. I had already thought about it, since my teaching activities sometimes involve showing live stuff to the students, but I never actually took the time to make one myself.

After a quick chicken dare (and I quote: “The Nicolas I know would make it in less than an hour, so why doesn’t it exist already?”), I took some time to look into it and it was actually pretty quick to code. An hour later, I had the first beta ready for Arnaud, and a day or so later (after receiving some feedback), I had a working and (hopefully) bug-free software to release. So here is Highlight, the magic pen!

Highlight icon

Quote from Versiontracker:

Highlight is a tool designed with teachers and demos in mind : it helps you attracting the attention of your audience on what happens on the screen. It is designed to be as unobtrusive and simple as possible, while letting you express your communicating skills efficiently.

End quote

In essence, it’s an invisible sheet sitting on top of your screen that lets you draw… well whatever you might want to draw. It had a pretty decent feedback from users.

I just love this screenshot, so I’ll put it here:

Applesfera shot
This is taken from Applesfera

[UPDATE] Someone asked me to put highlight on a magazine CD. Whoohoo!

%d bloggers like this: