A Four Week Approach to Creating Abstracts

I'm often asked how I go about creating abstracts, and it's actually the theme of one of my workshops at LetsTest this year with Martin Hynie. So I thought I would share a timeline with you of how I tend to do it.

Most CFP on average give you around about two months to submit your abstracts, so there is plenty of time, to come up with and formulate those awesome ideas of yours. I tend to take a four week approach.

Week 1
As most of you know, I love my whiteboard. But if you don't have one, there are many other mediums you could use. So what I do in week one is I create a mind map of potential ideas for a talk, workshop or tutorial. I spend no more than 15 minutes on this initially, as I'm looking for things that are on my mind right now. These ideas could be anything, e.g:

  • A blogpost/podcast/video you have seen recently, that you could expand on or argue against.
  • An experience in work, that you feel could make a good story.
  • Something you have been blogging about that could be turned into a talk.
  • Something related to a book you have been reading or read recently.
Then after 15 minutes I stop. Then for the reminder of that week, new ideas and experiences will come to me, so I add those to the mind map. One of the reasons why it's important to always carry something to take notes on, to capture these ideas, a small notebook or your phone.

Week 2
Now at this point I have a mind map contains some ideas. It's now time to try and elaborate on some of them. So I take each node one by one and spend no more than 10 minutes on each node, elaborating on it. Noting key bits of information. For example, if it was an experience at work, I would write down the key people, the problem, quotes, timeline of events, my learnings. 

Once I've done this for each node, I stop and keep adding to it over the next few days when I remember new things. 

Now at this stage, I have a visualisation of my potential talks, and some may stand out more than others. Perhaps the one with more child nodes means you have more ideas about that, it resonates with you more than the others. Perhaps you can spot a nice theme or pattern in one, that you feel would structure a good talk. 

So the remainder of week 2, I take my top three ideas and elaborate on those even further. So to continue the example above, what is it about the key people that is important? What role do they play, are they a positive/negative part to the story, or both. What is problem? How did you identify the problem in the first place. What was this problem impacting. How did you know the problem had been solved? Continuing to do this as above over the remainder of week, adding to it when I remember new things, or have new ideas. 

So at the end of week two, we have three ideas that we have expanded two levels deep now. 

Week 3
So in week three it's time to try and create some abstracts. Take our expanded ideas and try and create a snippet of your story, to entice reviewers to it. In my opinion this is one of the hardest parts, especially if the art of writing doesn't come naturally to you, like me. 

I tend to create a document in google drive, reasons for this later. I take a picture of my mindmap, screenshot if you did it electronically, and I add that to the top of my document for ease of reference. I start my abstract by spending no more than 5 minutes trying to think of some good titles and I note them all down, no matter how crazy some are. Then it's time to write that gripping, sock knocking off, enticing abstract.

Again my time boxing theme continues, it's how I tend to work. I spend no more than 60 minutes writing my first draft. I take the parent node and all its child and try and translate that into some words to explain why it was added to my map. So to continue my example, I may write something like: "this story contains many characters, during my story I will introduce them and their importance in this story, expanding on how their actions impacted my approach to solving this problem, and how their characteristics lead to me changing my interactions with them". Something like this. 

Once all the nodes are done, we should hopefully have a collection of relevant paragraphs and sentences that form the core of our story, it's not time to add some stitching in to turn them into one congruent abstract. Repeat the process for all three.

Now we are three weeks in at this point, that's a long time, that's a lot of thinking. You're probably getting a stronger feeling towards one of the abstracts, or maybe two of them. So I tend to spend some extra time on those to make sure I've included all I can think of in my 1st draft. 

Week 4
This is probably the most important week, we have invested a lot of time by this point, we believe we have some fantastic talks to give, and you believing in it is the most important thing. However, so far it's just you, your ideas, your thoughts on what is interesting. So it's time to get some reviews. This is why I tend to use google drive, as it's easy to share and track comments.

The testing community is a very friendly space, most of the time at least, but especially when I am around :D. There are lots of people willing to help other people out. But what exactly is it your are looking to have reviewed?

The least important thing is your story or theme of your talk in my opinion. May surprise some people, but for you to get this far with it, means you care about it, you believe it's interesting. Doesn't mean you shouldn't ask for feedback on it, or change it based on the feedback offered, but for me, it's not the main thing I am after.

The most important is the words. Spelling and grammar are of course up there. After that though, it's about it's enticement. Is it congruent. Does it pull your reviewer in? Would they attend your talk, because of the abstract, not because it's you. Get their feedback on those things, then tweak and amend accordingly.

Also, read it several times yourself, with sufficient time in between, like a day or so. As I mentioned already, I find time in between allows my brain to give me all it has to offer. 

At the end of week four? Well, you pick one of those titles and you get it submitted of course, then patiently, but excitably wait for the decision. Knowing that you gave it all your could, your best efforts.

Additional notes

Now of course you could do this a lot quicker than four weeks, however I find the time in between the weeks really allows my brain to process all the ideas and inform me of all it has to offer.

Also you don't have to wait until week 4 to get some external input, it could be useful to ask some close peers or work colleagues if they have something they believe you could talk about. 

Once you've done this process multiple times, you will also have a backlog of potential talk ideas. I tend to store these one big central map, which in turn could speed up weeks one and two. However I try not to go straight to this map, unless I hear about a CFP to something that seems interesting to late to adopt the four week approach.

Why Was This Check Created?

As I've been thinking more about Checking and Testing, and how to get them working harmoniously, I'm wondering if we are missing something from our checks. This post will focus on automated checks, but it I believe the same applies to non automated checks.

Some teams have become really adapt at writing automated checks. They are following good practices. Classes, methods and objects are all well named, and it's obvious what they do. Assertions are clear, and have a well structured message for when they fail. There are good layers of abstraction and code re-use. They are performant, execute fast and designed to reduce flakiness. It all sounds rather good.

But why is that well designed, well written, easy to read check there? Why does it exist. Why was this check written, over all the other possible checks. I can read the check, it's well written as mentioned, I can clearly see what it is checking, but that is all I have. How do I know, that the steps and the assertion(s) there match the initial intention for it. What was it about this check, this system behaviour, that was worthy of having an automated check created for it. I don't know that.

Why should we care about the why? I believe the results of automated checks are impacting the way we test. I believe this is especially true in an environment that has adopted continuous integration. As before you test, by test here I mean testing once the developer believes she is "code complete", all the automated checks are ran, and the build is either red or green. A generalisation for now, as I am still giving this more thought, but when the build is red, we tend to immediately focus on that, by chasing green. We will then usually read over the other checks in that area to see what else is covered, and then design and execute some tests to see what else we can learn. Then return to the new piece of work. When the build is green, we tend to focus our testing efforts on and around the new piece of work. As I said, it's a generalisation for now, I know I/we don't always do this, but hopefully most can relate.

I believe we aren't always aware of how much trust we put in our automated checks, and all that trust without always knowing why the check exists or it's importance. We all have a lot of knowledge about our systems, a lot of that knowledge is interwoven, this is why we create automated checks, because we can't remember everything. We need to make some of this tacit knowledge, explicit. It's also why we create mindmaps and checklists, to prompt us to remember things. To consider things.

If the why was also included, I feel it would aid us with test design. It would also aid us when reviewing our automated checks, when deciding do amend some, or delete some. Regularly viewing your checks and questioning their value is something I encourage teams to do regularly. Just because a check is green, doesn't mean it helped you in anyway, doesn't mean it added any value to your testing efforts. Going back to test design, lets say a check failed that had the following why message somewhere: "This check was created as we had a major issues in live where the system did X and lead to Y downtime". If I saw such a failed check, I believe I would probably do more testing in that area than if that message wasn't there. If I was reviewing my checks, and saw such a message, I would be able to assess it's value a lot easier/faster.

Here are multiple ways we could add the why in.

  1. Code Comment - No doubt a lot of you have turned your nose up reading that. But I'm not talking about using them to be able to read what the code does, as stated, we can do that. I'm talking about a few lines above a check, explaining why it's been created.
  2. BDD Tool Lovers - While I discourage people using BDD tools to write automated checks, especially those places that aren't practising BDD, I know many of you are using such tools. So you could add the why to the scenario section of the feature file. 
  3. Commit message - Perhaps we ensure to add excellent commit messages when new checks are created, clearly indicating the why there. We could then look at the commit history of the file. Has flaws if checks are moved around a lot during refactoring. 
  4. External document - Or perhaps we could store the why in a document somewhere. Perhaps a mindmap with IDs for the checks
Even though my thoughts are early days, I don't believe adding the why is a huge deal, the fact you are creating it means you already know why, it's just not there later in the checks life. Or available for new team members to read. Or anyone. But I do believe it could play a significant part is assisting our testing efforts, especially in check reviews and test design.

These are some early thoughts, just had an urge to write something after several conversations at Euro Testing Conference on this subject. Would love to hear some of your thoughts if you have the time to engage. 

Thanks.