- •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
108 Speciication by Example
What are nonfunctional requirements?
Characteristics |
such |
as |
performance, |
usability, |
or |
response |
times |
are often |
|||||||||||||
called nonfunctional because they aren’t related |
to isolated functionalityI . |
||||||||||||||||||||
generally |
disagree |
with |
the |
practice |
of |
categorizing |
requirements |
as |
functional |
||||||||||||
or nonfunctional, but that’s probably |
a topic for another book. Many features |
||||||||||||||||||||
commonly termed nonfunctional imply functionality. For example, performance |
|||||||||||||||||||||
requirements |
|
might |
imply |
a |
caching |
function, |
persistence |
constraints, and so |
|||||||||||||
on. From my experience, what most |
people |
think |
of |
whenonfuncthey- |
say |
||||||||||||||||
tional are |
functional |
requirements |
that |
are |
cross-cutting |
(for |
example, |
security) |
|||||||||||||
or |
not |
discrete |
but |
measurable |
on |
a sliding scale (for example, |
performance). |
||||||||||||||
Dan |
North |
|
points † outthat |
requirements |
listed |
as |
nonfunctional |
usually |
imply |
||||||||||||
that |
there’s |
|
a |
stakeholder |
whom |
the |
team hasn’t |
yet explicitly |
identiied. |
||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||
ł In |
private |
communication |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
So far, I haven’t seen a single nonfunctional requirement that couldn’t be illustrated using examples. Even usability, perhaps the vaguest and most subjective concept in software development, can be illustrated. Ask your usability expert to show you a website that she likes; that’s a good, realistic example. The validation of such examples might not be automatable, but the example is realistic and precise enough to spark a good discussion. Here are some ideas that will help you capture nonfunctional requirements with examples.
Get precise performance requirements
When: Performance is a key feature
Because performance tests often require a separate environment and hardware similar to what’s used in production, many performance-critical systems developers can’t run any relevant tests on their hardware. This doesn’t mean that teams
should skip a discussion about performance requirements.
Having |
the |
performance |
criteria |
clearly |
speciied a |
trated |
using |
examples |
will help |
build |
shared unde |
and provide the development team with a clear implementation.
At RainStor, performance is critical for their data-archiving tools, so they make sure to express the performance requirements in detail. Performance requirements are collected in the form “The system has to import X records within Y minutes on Z CPUs.” Developers then either get access to dedicated testing hardware or have the testers run tests for them and provide feedback.
|
|
Chapter 7 Illustrating |
using examples |
109 |
||
Remember that |
“faster |
than |
the |
current |
system” isn’t a good performance |
|
requirement. Tell |
people |
exactly |
how |
much |
faster and in what |
way. |
Use low-i prototypes for UI
User interface layouts and usability can’t be speciied easily with examples itting into truth tables or automated tests. This doesn’t mean that we can’t discuss examples.
I often create paper prototypes that are glued together from cutouts of user interface elements and website prints. Going through one or two examples is a good way to ensure that we have all the information a customer needs on a screen.
Business users often ind it hard to think beyond the user interface, because that’s what they work with. This is why boomerangs often happen when a client looks at the software on a screen.
Instead of discussing backend processing, we can sometimes get more concrete information up front by working through a user interface example.
Several teams I interviewed use Balsamiq Mockups,4 a web/desktop application for low-i user interface prototyping. I ind paper prototypes easier to work with because we can use cutouts and write notes, but a software system works better when we want to share our work.
At RainStor, Adam Knight took this approach even further by creating an interactive prototype to explore vague requirements with clients. He says:
Rather than a paper prototype we put together some example command line prototype interfaces using shell scripts and then walked these through with the customer, asking them to give us details on how they’d use the new functionality in our system.
This interactive workshop provided functional examples that the development team later used to illustrate requirements. Teams can use this approach to identify scope as well. (See “Don’t look only at the lowest level” in chapter 5.)
4 www.balsamiq.com/products/mockups