Lean Test Documentation

[article]
Summary:
Forcing testers to slog with document creation is a foolish thing to do for any organization, especially those that believe that keeping customers happy is their foremost goal. In this article, Parimala Hariprasad writes that adopting lean test documentation saves lot of time and energy for the tester.

In traditional test design, testers are forced to create scores of documents. A lot of time is wasted documenting detailed tests that are neither needed nor useful with the exception of mission-critical applications or unless you are testing for compliances and regulations in which heavy documentation is necessary.

Lean Test Documentation
When I say lean test documentation, I am referring to any test documentation that is optimal and capable of conveying the same information using fewer details. It is less verbose, less bulky in terms of number of pages and “lean.”

Traditional test documents are heavy in size, shape, and magnitude. They are detailed, consume a lot of time to write, and yet testers don’t have enough patience to gobble it up during testing.

As James Bach wrote in one of his blog posts on Test Documentation, “A lot of people I teach seem to be under pressure to create more documents to describe their test process. But documenting is not testing. It is one of the chief distractions to testing.”

Heavy documentation can be reduced by using smart techniques like mindmapping, outlines, checklists, and matrices. I have compared and contrasted these techniques below.

Mindmapping
A mindmap is a visual representation of ideas, concepts, or tasks encompassed within a central theme. It can be used for visual tracking of test coverage, testing sessions, feature priorities, and status reports.

Mindmaps prevent extensive and useless documentation by displaying content that is succinct and brief. For example, a tester can write many pages about product exploration and learning that can be transformed into a simple mindmap below.

P1

Figure 1. Example Mindmap

Mindmaps can simplify test approaches by crunching scores of pages into a worksheet, as this mindmap on Claims Testing shows.

This other example of a mindmap posted on the Moolya blog summarizes a list of heuristics used for mobile application testing. This demonstrates how even lengthy documents can take the form of self-explanatory visuals.

Pros:

  • Flexible and easy to use
  • Triggers creativity
  • Facilitates Quick Updates in the world of changing requirements
  • Reduces test documentation time saving time for real testing

Cons:

  • Mindmaps cannot be converted to direct excel reports
  • Unsuitable on metrics-crazy projects
  • Unfit for detailed documentation

Checklists
A checklist is a master list of items that needs to be checked against before, during, or after performing some action. For example, when a pilot refers to a pre-flight checklist to confirm if everything is in place.

Atul Gawande, author of  The Checklist Manifesto says, “Checklists provide a cognitive net. They catch mental flaws inherent in all of us—flaws of memory and attention and thoroughness.”

User Comments

6 comments
Kobi (Jacob) Halperin's picture

Thanks for an interesting article,

There is a lot more to that subject,

One can still use MS-Word or an ALM system - and write only Name & Purpose to keep it lean

November 28, 2013 - 9:36am
Justin Rohrman's picture

Hi Parimala, one light weight / lean approach to documenting tests I like use occasionally is session reports a la session based test management. I like using session reports reports because unlike some other methods where testing is documented before it happens, this records testing as it actually happened. Also, you have the option of giving a brief narrative of what was learned while testing.

Here is a good place to read about that: http://www.satisfice.com/articles/sbtm.pdf

November 18, 2013 - 8:51pm
Pradeep Lingan's picture
Pradeep Lingan

Hi Pari,

Nice to read your blog. I have few things to share with.

I see many people share about what James, Cam Caner, Pradeep

says,instead what they want to say. I think at particular point most of them fail to share what they what to say on the topic

they are discussing about.

Her are my questions

1. Are these people (James, Cam Caner, ) are the only expert,great testers in the world?

2.Will their opinion be right all times?

3.Are people whom ever follow them are blind believer?

I don't say (comment) that what ever they share should not be followed or wrong. I always respect those people for some reasons. I just want to say that it would be better if you share your own opinion in your articles.

I see one person has shared a link of James in the comment section. I think it would be good if he share the blog of his own if he has.

Sometimes it looks like he/she don't have trust on their jobs instead they blindly believe on some one else jobs.

It is not to hurt someone, I am just sharing my thoughts.I am sorry if my comment hurts some one.

November 19, 2013 - 1:17am
Fiona Charles's picture
Fiona Charles

Hi Pari,

Nice article! So many testers still seem to be stuck in the deep mud of excessive documentation, it's essential that we all keep writing about the alternatives.

I blogged about this topic on: http://quality-intelligence.blogspot.ca/ "Breaking the Tyranny of Form". Readers might find some of the visual techniques I refer in that post useful in addition to the ones you have described here.../Fiona

November 19, 2013 - 6:18pm
Parimala Hariprasad's picture
Parimala Hariprasad

@Fiona

Thanks for your time Fiona. I read your article. It has many other insights into Visual Thinking around Test Documentation.

@Justin

I agree Session Notes are a great source of Test Documentation too. I have used it on a couple

November 19, 2013 - 11:11pm
Rafael Battesti's picture

Hi Parimala.

Thanks for the very nice article!

From where I stand, the mindmaps are specially insightful. ;-)

I'll keep following your good tips.

Best regards.

January 10, 2014 - 10:44pm

StickyMinds is one of the growing communities of the TechWell network.

Featuring fresh, insightful stories, TechWell.com is the place to go for what is happening in software development and delivery.  Join the conversation now!

Upcoming Events

Nov 09
Nov 09
Apr 13
May 03