- •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 |
105 |
They looked at an email archiving system and said we need to be able to work in the same way. An email archiving system would have thousands of emails, but in our system you could have billions of records. Do you want the same level of granularity? What about logging? That is the most dificult kind of requirement. Generally we try to push back and get examples. We arrange demos to prototype functionality and walk through that.
To avoid ambiguities and misunderstanding between what the product manager thinks the customers need and what they ask for, insist on examples when communicating with customers. These examples can then be used to kick-start the discussion during speciication workshops. They should be included in the inal executable speciications to ensure that the customers’ expectations are met.
Examples should be easy to understand
A common mistake teams make when starting out with Speciication by Example is to illustrate requirements using complex and convoluted examples. They focus on capturing realistic examples in precise detail and create huge, confusing tables with dozens of columns and rows. Examples like these make it hard to evaluate consistency and completeness of speciications.
One of the main reasons I prefer examples over abstract statements as requirements is that they allow me to think about functional gaps and inconsistencies. Making things precise makes it easier to spot missing cases. This requires an understanding of the entire set of examples for a particular feature. If the examples aren’t easy to understand, we won’t be able to evaluate their completeness and consistency. Here are some ideas on how to avoid that problem and still keep the examples precise and realistic.
Avoid the temptation to explore every combinatorial possibility
When teams start illustrating their requirements using examples, testers often misunderstand the purpose of that process and insist on covering every possible combination of arguments. There isn’t much point in going through examples that illustrate existing cases; that doesn’t improve understanding.
When illustrating using examples, look for examples that move the discussion forward and improve understanding.
I strongly advise against discarding any examples suggested as edge cases without discussion. If someone suggests an edge case example that the others consider to have
106 Speciication by Example
been covered already, there might be two possible reasons: Either the person making the suggestion doesn’t understand the existing examples, or they have genuinely found something that breaks the existing description that the others don’t see. In both cases, it’s worth discussing the example to ensure that everyone in the room has the same level of examples suggested as edge casesunderstanding.
Look for implied concepts
When you use too many examples to illustrate a single function or the examples are complex, this often means that the examples should be described at a higher level of abstraction.
Look |
at the |
examples |
and try to identify |
concepts |
that are hidden |
and |
implied |
|
Make |
those |
concepts |
explicit |
and deine them separately. Restructuring |
exam- |
|||
ples |
like this will make the |
speciications |
easier to |
understand and |
will |
lead to |
||
better |
software design. |
|
|
|
|
|
|
Looking for missing and implied concepts and making them explicit in system design is one of the core ideas of domain-driven design.3
I facilitated a workshop for a team that was rewriting an accounting subsystem and gradually migrating trades from the legacy system to the new product. The workshop was focused on a requirement to migrate Dutch trades to the new system. We started writing examples on a whiteboard and quickly illed all the available space. Looking at the examples, we discovered that we were explaining three things: how to decide which trades are Dutch, how to decide which trades are migrated, and what happens to a trade once it’s migrated.
Because we were illustrating all these things at the same time, we had a combinatorial explosion of relevant cases to deal with. When trying to summarize the examples, we identiied two implied concepts: a trade location and a migration status. We then broke this requirement into three parts and used a separate, focused set of examples to illustrate each part. We had a speciication of how to decide whether a trade is Dutch or not (how to calculate the location of a trade). Another focused set of examples illustrated how the location of a trade affects its migration status. In that set, we used Netherlands only once, without having to go through all the cases that constitute a Dutch trade. The third set of examples illustrated the difference in processing between migrated and nonmigrated trades.
3 Eric Evans,Domain-Driven Design: Tackling Complexity in the Heart of Software (Boston, Addison-Wesley Professional, 2003).