- •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
242 Speciication by Example
The testers then run their manual tests, start doing exploratory testing, and provide feedback to the developers. Once the testers and the developers agree that a feature is ready, it goes into a queue for integration.
Features from the queue are integrated into the master branch. The entire continuous validation suite is then executed, the code is deployed to a staging environment, and the testers run inal core functionality manual tests. After that, the code goes live to a production environment.
Ah-ha moments
I asked Cowans about the key |
ah-ha moments for him from |
related |
to |
thei |
|||||||||||||||||||||||
implementation |
of |
Speciication |
by |
Example. |
He |
says: |
|
|
|
|
|
|
|
|
|
||||||||||||
• It’s |
|
quite |
|
easy |
to |
test |
what |
|
you |
can |
see, |
but |
ultimately |
|
you |
|
need |
to |
have |
||||||||
a |
deep |
understanding |
of |
what |
the |
software |
does |
rather |
|
than |
|
what |
the |
||||||||||||||
user interface looks like. Thinking in terms |
of |
|
user |
stories |
and paths |
||||||||||||||||||||||
through |
the |
application |
really |
helps. |
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||
• Treat |
your |
test |
suite as |
a |
irst-class |
citizen. |
It |
needs |
careful |
maintenance |
|||||||||||||||||
as |
much |
|
as |
the |
application |
|
code |
itself. |
|
|
|
|
|
|
|
|
|
|
|
||||||||
• The |
|
tests |
are |
the canonical |
|
description of what the application does. Ul- |
|||||||||||||||||||||
timately, success is as much |
about building the right thing as building it |
||||||||||||||||||||||||||
well. |
|
If |
the |
tests |
are |
your |
|
description |
of |
what |
the code |
|
does, |
they’re |
not |
||||||||||||
just |
|
an |
important |
part |
of |
your |
|
development |
process |
but |
|
an |
important |
|
|||||||||||||
part of the wider process |
|
of |
building |
the |
product. |
They |
can |
help |
you |
||||||||||||||||||
understand |
what you’ve |
built |
|
and |
keep |
complexity |
under |
control. |
|
|
|||||||||||||||||
• It’s |
|
important |
|
to |
have |
everyone |
|
in |
the |
process |
involved; |
it’s |
not |
just |
|||||||||||||
something that developers do. Ultimately it |
[Speciication |
by Example] |
|
|
|||||||||||||||||||||||
gives |
you |
tests |
written |
by |
|
the |
|
developers |
that |
|
the |
product |
owner |
can |
|||||||||||||
read. You |
|
should |
make |
good |
|
use |
of |
that. |
|
|
|
|
|
|
|
|
|
|
|
Key lessons
The key lesson from Songkick for me was that if you don’t have a massive legacy system to slow you down, it’s possible to go from TDD to Speciication by Example quickly. At Songkick they just approached it an extension of the TDD process to cover business functionality.
Chapter 17 Songkick |
243 |
The team builds and maintains a web system, so they initially automated tests in a way that was too closely tied to the user interface. This caused lots of maintenance problems and led them to start reining the speciications and automating user interface checks at a higher level of abstraction.
It took them about one year to start thinking about a living documentation and seeing how important that can be when parts of the system are rewritten.
As a startup, Songkick beneits greatly from focusing on delivering the things that really matter. A shared understanding from collaborating on speciications ensures that they all focus on delivering the right product. The second most important beneit for them comes from executable speciications, because they discover problems early and can focus on rolling out new functionality rather than wasting time troubleshooting and ixing bugs.
Chapter title |
245 |
18
Concluding thoughts
Ibegan my research for this book because I was seeking external conirmation. I wanted to document that there are many teams that produce great software using agile techniques. I hoped that they were using BDD, agile acceptance testing, or what I would come to call Speciication by Example. I thought I already knew
how these processes worked and that I would ind other people applying them in the same way I was. But the more research I did, the more unexpected lessons I learned. I found that many teams working in different contexts used a variety of practices and techniques to get to the same results. This proved that there’s no such thing as a “best practice.” Software development is incredibly contextual, and what might seem like a good idea for one team might be completely wrong for another.
Looking back, it surprises me how much I’ve learned about delivering high-quality software effectively. Some of these discoveries were completely new to me. Some were the result of viewing something with which I was familiar from a wider perspective, which gave me a much deeper understanding of the real forces behind the practices. To conclude this book, I’d like to present the top ive things I’ve learned.
Collaboration on requirements builds trust between stakeholders and delivery team members
In Bridging the Communication Gap, I wrote that speciication workshops have two main outputs. One is tangible: the examples or speciications. Another is intangible: a shared understanding of what needs to be done that’s the result of a conversation. I stipulated that shared understanding might be even more important than the examples themselves. But it turns out the situation is much more complicated; there’s another intangible output that I discovered when researching this book.
The examples of uSwitch, Sabre, Beazley, and Weyerhaeuser show that collaboration on speciications sparks a change in the culture of teams. As a result, development, analysis, and testing become better aligned and teams become better integrated.
245