-
Notifications
You must be signed in to change notification settings - Fork 3
/
Example.html
194 lines (154 loc) · 7.1 KB
/
Example.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Concordion - Example</title>
<link media="all" rel="stylesheet" type="text/css" href="css/default.css"/>
<link media="print" rel="stylesheet" type="text/css" href="css/print.css"/>
<link rel="icon" type="image/vnd.microsoft.icon" href="favicon.ico" />
<style>
code a {
font-family: Courier New, Courier, Monospace;
}
h3 {
margin-top: 32px;
}
.section {
margin-top: 60px;
border-bottom: 1px dotted black;
padding-bottom: 8px;
}
.helpfulNote {
border: 1px solid gray;
padding: 8px;
margin-top: 30px;
background-color: #fffff0;
width: 600px;
}
</style>
</head>
<body>
<div class="page">
<div class="header">
<div id="google_translate_element" class="language-translation"></div>
<div class="logo"><a href="index.html"> <img src="image/front-page-banner.png" alt="Specification by Example" /> </a></div>
</div><!-- header -->
<div class="menuBar">
<ul class="menu">
<li><a href="/">Home</a></li>
<li class="selectedTab"><a href="Example.html">Example</a></li>
<li><a href="Tutorial.html">Tutorial</a></li>
<li><a href="Technique.html">Hints and Tips</a></li>
<li><a href="ExtensionsAPI.html">Extensions API</a></li>
<li><a href="Extensions.html">Extensions</a></li>
<li><a href="Download.html">Download</a></li>
<li><a href="Questions.html">FAQ</a></li>
</ul>
</div><!-- menuBar -->
<div class="content">
<p>
This example shows one way of working with Concordion. Given the flexibility that is built into Concordion, you can use it in many ways.
For example, you might be documenting your features, rather than individual stories. Or you might not be working with stories or features at all.
You might be writing your specifications after coding. But you'll get more benefit from discussing them before.
</p>
<div class="memo">
<h1>Example: Online Shopping Site</h1>
<p class="subtext">
Imagine that we are working on an online shopping site, like Amazon. We are
already several iterations in, but there's still plenty of functionality we
can add.
</p>
<h2>1. Choose a story to be implemented</h2>
<p>
From the dozens of possible stories, the following card has
been chosen for implementation in this iteration:
</p>
<center>
<img src="image/example/online-shop/StoryCard.png" alt="Story card"/>
</center>
<p>
On the back of the card are some rough jottings about the
scope:
</p>
<center>
<img src="image/example/online-shop/RoughScope.png" alt="Story card - rough scope"/>
</center>
<h2>2. Write a story page</h2>
<p>
The story page acts as a summary of the acceptance criteria as agreed
by the group. It is the output of a discussion about the story between
developers, testers and the story owner / business expert.
</p>
<p>
In our case, the page is divided into sections "Automated", "Manual" and "Out of Scope".
Many of the repetitive checks can often be automated, but manual checks are sometimes needed as well.
For example, one of the manual tests is to "check user-interface changes are consistent with rest of system"; this kind of test cannot be easily automated.
By automating the checks, we free up time for our testers to perform <a href="https://en.wikipedia.org/wiki/Exploratory_testing">exploratory testing</a>,
using their experience and creativity to explore new test ideas.
</p>
<center>
<img src="image/example/online-shop/StoryPage.png" alt="Story page"/>
</center>
<h2>3. Write acceptance criteria and examples</h2>
<p>
Again, these are discussed as a group.
This allows us to clarify requirements, resolve misunderstandings and find requirements defects and gaps.
It also gets the team on the same page, developing a shared understanding and a common language.
By doing this <b>before</b> any coding begins, we increase our chances of building the right thing, minimising the amount of rework needed.
</p>
<p>
Each of the items under the "Automated" heading in the story page
is a link to an acceptance test.
These tests are under a different hierarchy to the stories and organised
in a way that results in easily navigable documentation. If you use the
right conventions, Concordion will automatically insert breadcrumbs for
you.
</p>
<p>
Each page consists of a concise heading, a description and one or more examples.
The breadcrumbs give you context, so you don't need to have long wordy
headings and descriptions.
</p>
<p>
You'll notice that this page is pretty simple to understand and maybe
looks overly simplistic. But it's not; rather than having complicated
tests that test many things, you can have simple tests that test one thing
at a time. Complex behaviours are defined one small strand at a time by
decomposing the behaviour. The "Further Details" section at the bottom
of the page lists a number of questions that you might ask about the
functionality. Each question links to another (equally simple) specification
and so on until you run out of questions.
</p>
<center>
<img src="image/example/online-shop/AcceptanceTest.png" alt="Acceptance test"/>
</center>
<h2>4. Now everyone knows what "done" means for the story</h2>
<p>
It takes some time to write the acceptance criteria; perhaps 2 or 3 hours for
a 5 pair-day story. But it pays dividends in terms of focus, test coverage,
and cutting scope creep. Plus, if you take care, you can build up some very
valuable documentation that does not go stale.
</p>
</div>
</div> <!-- content -->
</div> <!-- page -->
<div class="copyright">
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
</div> <!-- copyright -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-58172036-1', 'auto');
ga('send', 'pageview');
</script>
<script type="text/javascript">
function googleTranslateElementInit() {
new google.translate.TranslateElement({pageLanguage: 'en', layout: google.translate.TranslateElement.InlineLayout.SIMPLE, gaTrack: true, gaId: 'UA-58172036-1'}, 'google_translate_element');
}
</script>
<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
</body>
</html>