- •Contents
- •Preface
- •Acknowledgments
- •About the author
- •About the cover illustration
- •Higher product quality
- •Less rework
- •Better work alignment
- •Remember
- •Deriving scope from goals
- •Specifying collaboratively
- •Illustrating using examples
- •Validating frequently
- •Evolving a documentation system
- •A practical example
- •Business goal
- •An example of a good business goal
- •Scope
- •User stories for a basic loyalty system
- •Key Examples
- •Key examples: Free delivery
- •Free delivery
- •Examples
- •Living documentation
- •Remember
- •Tests can be good documentation
- •Remember
- •How to begin changing the process
- •Focus on improving quality
- •Start with functional test automation
- •When: Testers own test automation
- •Use test-driven development as a stepping stone
- •When: Developers have a good understanding of TDD
- •How to begin changing the team culture
- •Avoid “agile” terminology
- •When: Working in an environment that’s resistant to change
- •Ensure you have management support
- •Don’t make test automation the end goal
- •Don’t focus on a tool
- •Keep one person on legacy scripts during migration
- •When: Introducing functional automation to legacy systems
- •Track who is running—and not running—automated checks
- •When: Developers are reluctant to participate
- •Global talent management team at ultimate software
- •Sky Network services
- •Dealing with sign-off and traceability
- •Get sign-off on exported living documentation
- •When: Signing off iteration by iteration
- •When: Signing off longer milestones
- •Get sign-off on “slimmed down use cases”
- •When: Regulatory sign-off requires details
- •Introduce use case realizations
- •When: All details are required for sign-off
- •Warning signs
- •Watch out for tests that change frequently
- •Watch out for boomerangs
- •Watch out for organizational misalignment
- •Watch out for just-in-case code
- •Watch out for shotgun surgery
- •Remember
- •Building the right scope
- •Understand the “why” and “who”
- •Understand where the value is coming from
- •Understand what outputs the business users expect
- •Have developers provide the “I want” part of user stories
- •When: Business users trust the development team
- •Collaborating on scope without high-level control
- •Ask how something would be useful
- •Ask for an alternative solution
- •Make sure teams deliver complete features
- •When: Large multisite projects
- •Further information
- •Remember
- •Why do we need to collaborate on specifications?
- •The most popular collaborative models
- •Try big, all-team workshops
- •Try smaller workshops (“Three Amigos”)
- •Pair-writing
- •When: Mature products
- •Have developers frequently review tests before an iteration
- •When: Analysts writing tests
- •Try informal conversations
- •When: Business stakeholders are readily available
- •Preparing for collaboration
- •Hold introductory meetings
- •When: Project has many stakeholders
- •Involve stakeholders
- •Undertake detailed preparation and review up front
- •When: Remote Stakeholders
- •Prepare only initial examples
- •Don’t hinder discussion by overpreparing
- •Choosing a collaboration model
- •Remember
- •Illustrating using examples: an example
- •Examples should be precise
- •Don’t have yes/no answers in your examples
- •Avoid using abstract classes of equivalence
- •Ask for an alternative way to check the functionality
- •When: Complex/legacy infrastructures
- •Examples should be realistic
- •Avoid making up your own data
- •When: Data-driven projects
- •Get basic examples directly from customers
- •When: Working with enterprise customers
- •Examples should be easy to understand
- •Avoid the temptation to explore every combinatorial possibility
- •Look for implied concepts
- •Illustrating nonfunctional requirements
- •Get precise performance requirements
- •When: Performance is a key feature
- •Try the QUPER model
- •When: Sliding scale requirements
- •Use a checklist for discussions
- •When: Cross-cutting concerns
- •Build a reference example
- •When: Requirements are impossible to quantify
- •Remember
- •Free delivery
- •Examples should be precise and testable
- •When: Working on a legacy system
- •Don’t get trapped in user interface details
- •When: Web projects
- •Use a descriptive title and explain the goal using a short paragraph
- •Show and keep quiet
- •Don’t overspecify examples
- •Start with basic examples; then expand through exploring
- •When: Describing rules with many parameter combinations
- •In order to: Make the test easier to understand
- •When: Dealing with complex dependencies/referential integrity
- •Apply defaults in the automation layer
- •Don’t always rely on defaults
- •When: Working with objects with many attributes
- •Remember
- •Is automation required at all?
- •Starting with automation
- •When: Working on a legacy system
- •Plan for automation upfront
- •Don’t postpone or delegate automation
- •Avoid automating existing manual test scripts
- •Gain trust with user interface tests
- •Don’t treat automation code as second-grade code
- •Describe validation processes in the automation layer
- •Don’t replicate business logic in the test automation layer
- •Automate along system boundaries
- •When: Complex integrations
- •Don’t check business logic through the user interface
- •Automate below the skin of the application
- •Automating user interfaces
- •Specify user interface functionality at a higher level of abstraction
- •When: User interface contains complex logic
- •Avoid recorded UI tests
- •Set up context in a database
- •Test data management
- •Avoid using prepopulated data
- •When: Specifying logic that’s not data driven
- •Try using prepopulated reference data
- •When: Data-driven systems
- •Pull prototypes from the database
- •When: Legacy data-driven systems
- •Remember
- •Reducing unreliability
- •When: Working on a system with bad automated test support
- •Identify unstable tests using CI test history
- •Set up a dedicated continuous validation environment
- •Employ fully automated deployment
- •Create simpler test doubles for external systems
- •When: Working with external reference data sources
- •Selectively isolate external systems
- •When: External systems participate in work
- •Try multistage validation
- •When: Large/multisite groups
- •Execute tests in transactions
- •Run quick checks for reference data
- •When: Data-driven systems
- •Wait for events, not for elapsed time
- •Make asynchronous processing optional
- •Getting feedback faster
- •Introduce business time
- •When: Working with temporal constraints
- •Break long test packs into smaller modules
- •Avoid using in-memory databases for testing
- •When: Data-driven systems
- •Separate quick and slow tests
- •When: A small number of tests take most of the time to execute
- •Keep overnight packs stable
- •When: Slow tests run only overnight
- •Create a current iteration pack
- •Parallelize test runs
- •When: You can get more than one test Environment
- •Try disabling less risky tests
- •When: Test feedback is very slow
- •Managing failing tests
- •Create a known regression failures pack
- •Automatically check which tests are turned off
- •When: Failing tests are disabled, not moved to a separate pack
- •Remember
- •Living documentation should be easy to understand
- •Look for higher-level concepts
- •Avoid using technical automation concepts in tests
- •When: Stakeholders aren’t technical
- •Living documentation should be consistent
- •When: Web projects
- •Document your building blocks
- •Living documentation should be organized for easy access
- •Organize current work by stories
- •Reorganize stories by functional areas
- •Organize along UI navigation routes
- •When: Documenting user interfaces
- •Organize along business processes
- •When: End-to-end use case traceability required
- •Listen to your living documentation
- •Remember
- •Starting to change the process
- •Optimizing the process
- •The current process
- •The result
- •Key lessons
- •Changing the process
- •The current process
- •Key lessons
- •Changing the process
- •Optimizing the process
- •Living documentation as competitive advantage
- •Key lessons
- •Changing the process
- •Improving collaboration
- •The result
- •Key lessons
- •Changing the process
- •Living documentation
- •Current process
- •Key lessons
- •Changing the process
- •Current process
- •Key lessons
- •Collaboration requires preparation
- •There are many different ways to collaborate
- •Looking at the end goal as business process documentation is a useful model
- •Long-term value comes from living documentation
- •Index
Chapter 7 Illustrating using examples |
97 |
I copied the rules of a blackjack game from a popular website and asked the participants to illustrate those rules using examples. Although the requirements were taken from a real website and it on a single sheet of paper, they were ambiguous, redundant, and incomplete. In my experience, this is often the case when requirements are captured as Word documents.
The participants were divided into seven teams, and each team had only one person with knowledge of blackjack. After the workshop, all the participants agreed that discussing realistic examples helped lush out inconsistencies and functional gaps. By running a feedback exercise (see sidebar), I measured the level of shared understanding. Six out of seven teams came up with the same answers to dificult edge cases, even though most people on the team had no previous exposure to the target domain. Illustrating requirements with examples is a very effective way to communicate domain knowledge and ensure a shared understanding. I’ve seen this effect on real software projects, as have many teams that I interviewed for this book.
Feedback exercises
Feedback |
|
exercises |
are a |
good |
way |
to check |
whether |
a |
group |
of |
people has |
||||||||||
shared understanding of a speciication. |
When someone suggests a special case |
||||||||||||||||||||
after |
a |
story |
has |
been |
discussed, |
the |
person |
running |
the |
workshop |
should |
ask |
|||||||||
the |
participants |
to |
write |
down |
how |
they |
think |
the |
system |
should |
work. |
The |
en |
||||||||
tire |
group |
then |
compares |
the |
answers. |
If |
they |
all |
match, |
everyone |
understands |
||||||||||
the speciication in the same way. If |
the |
answers |
don’t match, then |
it’s |
useful |
||||||||||||||||
organize |
the |
results |
into |
clusters |
and |
get |
one |
person |
from |
each |
cluster |
to |
ex |
||||||||
plain |
their |
answers. |
The |
discussion |
|
will |
reveal |
the |
source |
of |
misunderstanding. |
Illustrating requirements using examples is a simple idea, but it’s far from easy to implement. Finding the right set of examples to illustrate a requirement turns out to be quite a challenge.
In this chapter, I begin by putting things in perspective using an example of the process. Then, I present good ideas for identifying the right set of examples to illustrate a business function. Finally, I cover ideas for illustrating cross-cutting functionality and concepts that aren’t easy to capture with precise values.
Illustrating using examples: an example
To clarify how illustrating a requirement using examples works, let’s take a look at an example involving a ictional company, ACME OnlineShop. This is the only ictional company in the book, but I had to invent one to keep the example simple. Acme is a small web store whose development team started a Speciication workshop. Barbara, a
98 Speciication by Example
business analyst, spent some time the week before with Owen, the company owner, to get some initial examples. She’s facilitating the workshop and introduces the irst story:
BarBara: The next thing on the list is free delivery. We have arranged deal with Manning to offer free delivery on their books. The basic example is this: If a user purchases a Manning book, say Speciication by Example, the shopping cart will offer free delivery. Any questions?
David, a developer, spots a potential functional gap. He asks: Is this free delivery to anywhere? What if a customer lives on an island off South America? That free delivery will cost us much more than we earn from the books.
BarBara: No, this isn’t worldwide, just domestic.
Tessa, a tester, asks for another example. She says: The irst thing I’d check when this comes for testing is that we don’t offer free delivery for all books. Can we add one more case to show that the free delivery is offered only for Manning books?
BarBara: Sure. For example, Agile Testing was published by Addison-Wesley. If a user buys that, then the shopping cart won’t offer free delivery. I think this is relatively simple; there isn’t a lot more to it. Can anyone think of any other example? Can we play around with the data to make it invalid?
DaviD: There aren’t any numerical boundary conditions, but we could play with the list in the shopping cart. For example, what happens if I buy both Agile Testing and Speciication by Example?
BarBara: You get free delivery for both books. As long as a Manning book is in the shopping cart, you get free delivery.
DaviD: I see. But what if I buy Speciication by Example and a fridge? That delivery would be much more expensive than our earnings from the book.
BarBara: That might be a problem. I didn’t talk about that with Owen. I’ll have to get back to you on this. Any other concerns?
DaviD: Not apart from that.
BarBara: OK. Do we have enough information to start working, apart from the fridge problem?
DaviD anD Tessa: Yes.
BarBara: Great. I’ll get back to you on that fridge problem early next week.