The Ideal Test Plan

A colleague pinged me the other day, asking about an "ideal test plan" and wondering whether I could suggest something.

Not without a bit more information, I said.

OK, they said.

Who needs the plan, for what purpose? I asked.

Their response: it's for internal use, to improve documentation, and provide a standard structure.

We work in a medical context and have strict compliance requirements, so I wondered aloud whether the plan is needed for audit, or to show to customers?

It's not, they replied, it's just for the team.

Smiling now, I stopped asking questions and delivered the good news that I had what they were looking for.

Yes? they asked, in anticipation.

Naturally I paused for dramatic effect and to enhance the appearance of deep wisdom, before saying: the ideal plan is one that works for you.

Which is great and all that, but not heavy on practical advice.

--00--

I am currently running a project at the Association for Software Testing and there is a plan for it. In fact, there are plans.

1. I have a Google doc, shared with the rest of the AST Board, in which I've stated the Why of the project, in one sentence, at the top. The Why is the outcome we seek, independent of the way we might choose to achieve it. It's backed up by a few words about how we arrived at this need.

The rest of the doc is a time-stamped log of the research I did, decisions we made, decisions still to make, proposals to choose from, and actions I took. This is the plan as a goal and the evolution of our thinking.

2. I have a Google sheet (anonymised version here) in which I have summarised the current state and the specific state we have decided to go for, based on the conversations around (1). I have done this as a pair of adjacent tables where I have highlighted the most important changes as a visual diff, and provided a bullet list of key consequences of the changes.

It is structured deliberately for ease of consumption in order that my colleagues can review, compare to their understanding of our agreed approach, and approve or object. This is also the plan, the specific implementation we have decided we will aim for.

3. In the same Google sheet I have another table, this one with four columns: Action, Where, Notes, Status. Each row is a task I'll need to do to move from where we are to where we want to be. It lists the task, the place it needs to be done, references to decisions or resources, and whether it's To Do, Doing, or Done.

I'm a fan of conditional formatting, so that final column is automatically either red, orange, or green depending on the status. This too is the plan, the list of jobs I'll carry out and where we are with that.

Is it the ideal plan (or plans)? Well, it (or they) are doing what I need them to: providing visibility of what we're trying to do, how, when, where, and why.

--00--

Plans can and do take many forms. Off the top of my head I have examples of all of these in play right now: runbooks, checklists, trello cards, kanban boards, Jira tickets, to do lists, mind maps, and unrefined bundles of open-ended what-ifs in my head.

The plan format(s) for the AST project I talked about were chosen in the order you see them listed, tactically, to suit the need that I had at the point I wanted to commit to sharing them. I am not omnisicient. If at some point what I'd got wasn't serving my need I would have chosen a different way.

The plan-as-goal (1) is a format that I find to be a useful default for longish projects with unknowns. It's similar to the way that I record test notes for pieces of work that run for a while, perhaps over days, in a single thread.

The side-by-side comparison in the plan-as-implementation (2) evolved from a table that another board member created to help us discuss options during one of our discussions. With hindsight, and only a little reformatting and decoration, I realised that I could succinctly summarise the plan using it, so I did.

A set of tasks in the-plan-as-list (3) is not remotely original, but I enjoy the way that listing them explicitly helps me to see connections and ordering and grouping; enables others to spot things I've missed; and helps me not to forget something when I've had to pause the work for a while.

--00--

The different formats of plan that I've mentioned have pros and cons. The kinds of factors I might consider when choosing a format include:

what is the purpose of this plan (for me)?
who needs to see this plan?
what is the purpose of this plan (for others)?
what granularity am I working at?
what kind of information do I want to record?
what timespan will it be needed for?
will it be a living plan or a static one?
will I be recording ongoing status in it?
will I be collaborating in it, or am I the sole author with others as consumers?
will the plan be re-used?
what external constraints are there on this plan?
what proportion of time available is worth investing in planning for this project?

The lower the level the more I am likely to go for a list, tickets, or other artefacts that represent work items; for higher level I'll reach for a textual, tabular, or graphical representation.

For plans that need to be shared and collaborated on, I'll invest time in scaffolding such as a README, a Background section with references to earlier work, or naming schemes that help to track the ideas or tasks in play easily.

Using specialist tools for ongoing status monitoring will sometimes be appropriate. Other times it makes sense to keep status with other versions of the plan. The tools you have acess to and are familiar with is an important aspect of that decision.

When re-use is likely — such as in runbooks for repeated tasks — I'll try to strip the plan down to something that can be easily followed and make it a checklist. I'll try to flag actions and commentary differently to reduce the cognitive load on the reader.

If the plan is likely to be long-lived or needed as a record for posterity I will take care to put in dates, cross-references to related work, and decision points. Context that seems prominent now will not be so prominent in a few weeks.

--00--

If I had written down a plan for this post (which I didn't) I can tell you that it would not have included section dividers. In over 500 posts on Hiccupps, I have never used them this way before.

The up-front plan, to the extent that there was one, was to get out of my head the thoughts that had been swimming around in there since my colleague asked me for that ideal test plan. The dividers were initially a way to separate blobs of thought in the text file I used for drafting. During the writing I decided they served a useful purpose in breaking the text up, signalling that a different angle was being considered. So I left them in. A tactical decision.

That's not to say there was no planning. In the moment, as I had ideas spurred from the ideas I was trying to get down, I would add notes to lists in the sections that were evolving. Sometimes I created a new section. Sometimes I merged existing sections. Or deleted them. Contextual decisions, based on what I knew at that time. I was more likely to delete as I got further into the work. In this writing, and in general, I will tend to preserve more ideas in my plan the less well-formed it is, even if they are relegated to some kind of 'just in case' bucket.

And, again, this talk of tactics and context is not to reject up front planning. My experience and instinct is that I tend towards strategic, why-based, big-picture plans before I start, and to refining tactically as I go. You can see precisely this trajectory in the AST project I described.

This preference is not remotely original, although if you've ever worked anywhere that plans anything you will have seen that it's by no means universal.

--00--

To finish, then, back to that ideal test plan.

I recently joined the Exploratory Testing Slack instance set up by Maaret Pyhäjärvi and Ru Cindrea. One of the discussions in there last week was about planning exploratory testing and the use of chartering.

The term is somewhat loaded, not distinguishing well between the act of generating a specific set of tasks to be performed up front, choosing a piece of work to perform, and creating artefacts that describe the work performed.

I recognise all of these concepts but I realise that I have avoided the use of charter terminology in my own testing practice. Instead, I will try to understand what we're testing and why and what the constraints on that are. Having established the context, I'll try to identify what might be important to look at and for, I'll find a way to choose between those things, and then I'll pick something from the set to work on.

I might use a simple list, a mind map, or even a spreadsheet to represent the test ideas, constraints, and so on. I will default to using a text file for the notes I take during the testing itself.

Interestingly, the testing is a microcosm of the whole. I start by being explicit about my mission, I like Elisabeth Hendrickson's template: explore X using Y to achieve Z. It encapsulates the goal, the constraints, and the why. Then I work tactically and in context.

All of which means that I can now probably give a better answer than the glib one I tossed out at the beginning of this stream of consciousness.

The ideal way is that I plan my work, but I plan it in a context-driven way, taking into account whatever constraints exist, and using whatever representations, approaches, and tools are either required or serve my purpose. I want to understand the current strategy, but be free to change the tactics as the situation demands, and also to be able to question the strategy at any point. Seeking context-free perfection is a dead end.

Image: https://flic.kr/p/HCMQ8B

Meet Me Halfway?

The Association for Software Testing is crowd-sourcing a book, Navigating the World as a Context-Driven Tester , which aims to provide responses to common questions and statements about testing from a context-driven perspective . It's being edited by Lee Hawkins who is posing questions on Twitter , LinkedIn , Mastodon , Slack , and the AST mailing list and then collating the replies, focusing on practice over theory. I've decided to contribute by answering briefly, and without a lot of editing or crafting, by imagining that I'm speaking to someone in software development who's acting in good faith, cares about their work and mine, but doesn't have much visibility of what testing can be. Perhaps you'd like to join me? --00-- "Stop answering my questions with questions." Sure, I can do that. In return, please stop asking me questions so open to interpretation that any answ...

How do I Test AI?

Recently a few people have asked me how I test AI. I'm happy to share my experiences, but I frame the question more broadly, perhaps something like this: what kinds of things do I consider when testing systems with artificial intelligence components . I freestyled liberally the first time I answered but when the question came up again I thought I'd write a few bullets to help me remember key things. This post is the latest iteration of that list. Caveats: I'm not an expert; what you see below is a reminder of things to pick up on during conversations so it's quite minimal; it's also messy; it's absolutely not a guide or a set of best practices; each point should be applied in context; the categories are very rough; it's certainly not complete. Also note that I work with teams who really know what they're doing on the domain, tech, and medical safety fronts and some of the things listed here are things they'd typically do some or all of. Testing ...

Notes on Testing Notes

Ben Dowen pinged me and others on Twitter last week , asking for "a nice concise resource to link to for a blog post - about taking good Testing notes." I didn't have one so I thought I'd write a few words on how I'm doing it at the moment for my work at Ada Health, alongside Ben. You may have read previously that I use a script to upload Markdown-based text files to Confluence . Here's the template that I start from: # Date + Title # Mission # Summary WIP! # Notes Then I fill out what I plan to do. The Mission can be as high or low level as I want it to be. Sometimes, if deeper context might be valuable I'll add a Background subsection to it. I don't fill in the Summary section until the end. It's a high-level overview of what I did, what I found, risks identified, value provided, and so on. Between the Mission and Summary I hope that a reader can see what I initially intended and what actually...

The Best Programmer Dan Knows

I was pairing with my friend Vernon at work last week, on a tool I've been developing. He was smiling broadly as I talked him through what I'd done because we've been here before. The tool facilitates a task that's time-consuming, inefficient, error-prone, tiresome, and important to get right. Vern knows that those kinds of factors trigger me to change or build something, and that's why he was struggling not to laugh out loud. He held himself together and asked a bunch of sensible questions about the need, the desired outcome, and the approach I'd taken. Then he mentioned a talk by Daniel Terhorst-North, called The Best Programmer I Know, and said that much of it paralleled what he sees me doing. It was my turn to laugh then, because I am not a good programmer, and I thought he knew that already. What I do accept, though, is that I am focussed on the value that programs can give, and getting some of that value as early as possible. He sent me a link to the ta...

On Herding Cats

Last night I was at the Cambridge Tester meetup for a workshop on leadership. It was a two-parter with Drew Pontikis facilitating conversation about workplace scenarios followed by an AMA with a group of experienced managers. I can't come to work this week, my cat died. Drew opened by asking us what our first thoughts would be as managers on seeing that sentence. Naturally, sadness and sympathy, followed by a week ? for a cat ? and I only got a day for my gran! Then practicalities such as maybe there's company policy that covers that , and then the acknowledgement that it's contextual: perhaps this was a long-time emotional support animal . Having established that management decisions are a mixture of emotion, logic, and contingency Drew noted that most of us don't get training in management or leadership then split us into small groups and confronted us with three situations to talk through: Setting personal development goals for others. Dropping a clange...

Reasonable Doubt

In Your job is to deliver code you have proven to work Simon Willison writes: As software engineers we ... need to deliver code that works — and we need to include proof that it works as well. He is coming at this from the perspective of LLM-assisted coding, but most of what he says applies in general. I think this is a reasonable consise summary of his requirements for developers: Manual happy paths: get the system into an initial state, exercise the code, check that it has the desired effect on the state. Manual edge cases: no advice given, just a note that skill here is a sign of a senior engineer. Automated tests: should demonstrate the change like Manual happy paths but also fail if the change is reverted. He notes that, even though LLM tooling can write automated tests, it's humans who are accountable for the code and it's on us to "include evidence that it works as it should." Coincidentally, just the week before I read his post I told one of my...

Vanilla Flavour Testing

I have been pairing with a new developer colleague recently. In our last session he asked me "is this normal testing?" saying that he'd never seen anything like it anywhere else that he'd worked. We finished the task we were on and then chatted about his question for a few minutes. This is a short summary of what I said. I would describe myself as context-driven . I don't take the same approach to testing every time, except in a meta way. I try to understand the important questions, who they are important to, and what the constraints on the work are. With that knowledge I look for productive, pragmatic, ways to explore whatever we're looking at to uncover valuable information or find a way to move on. I write test notes as I work in a format that I have found to be useful to me, colleagues, and stakeholders. For me, the notes should clearly state the mission and give a tl;dr summary of the findings and I like them to be public while I'm working not just w...

Why Test, Test What, Then How?

There was a time when testing was all about the mnemonics . Well, we had no AI back then so thinking about our human craft and how to share what we had learned using our human intelligence with other engaged humans for later recall in their human heads seemed important. But this post isn't about dumping on AI. It isn't about mnemonics either even if WTTWTH does look like something that'd fit well into that ancient world. No, this post is just a snappier version of what I said to my team this week when I was walking through some testing I'd done the day before. It was concerned with a change to a particular turn in the dialog system we're building where multiple variables are in play, some populated by an external call to an LLM service. I wanted to make the point that the bulk of the testing work was done in the research I did and the spreadsheet I made, not in the interaction with our product. That spreadsheet was the result of me looking in our service's cod...

LLEWT 2024

This weekend I was at LLEWT 2024, a peer conference on Anglesey , north Wales, discussing communication. Given the day jobs of the participants, it was no surprise that the experience reports and the conversations that followed them mostly focussed on software development contexts. Notes from my presentation are in Express, Listen, and Field . I made sketchnotes (below) for each presentation and a mindmap (above) to try to summarise the whole. Without much reflection yet, I guess I would pull these common high-level threads from the day: There are multiple reasons that communication fails ... like, duh! ... but having multiple strategies for framing a message can help ... and having multiple tactics for delivering a message can help too. Understanding what you want from an interaction is key ... so setting the context to make that more likely is wise ... which might mean meta-conversation, being transparent, or changing your approach...

Exploring It!

This week the test team at Linguamatics held our first internal conference. There was no topic, but three broad categories could be seen in the talks and workshops that were given: experience reports, tooling, and alternative perspectives on our work. (The latter included the life cycle of a bug, and psychology in testing.) My contribution was an experience report looking at how I explore both inside and outside of testing. I've tidied up some of my notes from the prep for it below. There are testing skills that I use elsewhere in my life. Or perhaps there are skills from my life that I bring to testing. Maybe I'm so far down life's road that it's hard to tell quite what started where? Maybe I'm naturally this way and becoming a tester with an interest in improvement amped things up? Maybe I've so tangled up my work, life, and hobby that deciding where one starts and another ends is problematic? The answers to those questions is, I think, almost certai...

Hiccupps

Search This Blog