Home > Archive > Extreme Programming > June 2007 > XP's document template?
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
XP's document template?
|
|
| wolverine 2007-02-25, 10:01 pm |
| Hi!
I'm planning to start a new Java development project based on XP. For
this, I'm trying to identify the document templates needed for the XP
(is there any?).
For example, can you show me the template of the User Stories, Release
Plan, Acceptance Test Plan and etc? I'm not able to find such example
from the Internet...
Perhaps, do we really need the documents in XP?
In my case, the customer is located at difference country and hence,
we need a document to record the user stories.
Best Regards,
XP Newbie
| |
| Phlip 2007-02-26, 10:03 pm |
| wolverine wrote:
> I'm planning to start a new Java development project based on XP. For
> this, I'm trying to identify the document templates needed for the XP
> (is there any?).
Start with developer tests and customer tests.
There are those who call them "unit tests" and "acceptance tests",
respectively.
> For example, can you show me the template of the User Stories,
You write a note on a card and stick it on a cork board. The note could just
say "the frim can manage more than one fram". This is a reminder to have a
conversation about the card, to do it, and get it accepted by the customer.
> Release
> Plan, Acceptance Test Plan and etc? I'm not able to find such example
> from the Internet...
Those are just things you talk about in meetings.
The root of all documentation in XP is the test case. Put another way, any
energy you feel like expending to analyze a program, or store information
about the program for future use, you divert that energy into test cases.
You groom them until they document the program. And they also, as a
side-effect of good documentation, make life very hard for bugs.
> In my case, the customer is located at difference country and hence,
> we need a document to record the user stories.
Build a test server, such as via Fitnesse.org, and let them read, edit, and
run the tests remotely.
(Also appoint someone in your country, in your own site, to be the Customer
Liaison.)
--
Phlip
[url]http://www.greencheese.us/Z Land[/url] <-- NOT a blog!!!
| |
| John Roth 2007-02-27, 7:03 pm |
| On Feb 25, 8:08 pm, "wolverine" <wolverine...@gmail.com> wrote:
> Hi!
>
> I'm planning to start a new Java development project based on XP. For
> this, I'm trying to identify the document templates needed for the XP
> (is there any?).
>
> For example, can you show me the template of the User Stories, Release
> Plan, Acceptance Test Plan and etc? I'm not able to find such example
> from the Internet...
>
> Perhaps, do we really need the documents in XP?
>
> In my case, the customer is located at difference country and hence,
> we need a document to record the user stories.
>
> Best Regards,
>
> XP Newbie
There are only three required documents in XP: the code, the unit
tests and the automated acceptance tests. You couldn't find templates
for these because you were looking in the wrong places.
Unit tests are covered under Test Driven Development; there are a lot
of books on the technique. Executable Acceptance Tests are covered by
a number of tools, including FIT (fit.c2.com, www.fitnesse.org). There
is an excellent book on FIT "FIT for Developing Software" by Rick
Mugridge and Ward Cunningham.
"User Stories Applied" by Mike Cohn (Mountain Goat Software) is a good
book on user stories.
A release plan is one of the outputs of the Planning Game. You
couldn't find a template because it's typically just a list of
stories, together with estimates and an assignment to the iteration.
The Acceptance Test Plan is very simple: you write Executable
Acceptance Tests as part of requirements analysis _before_ beginning
coding on each story. When the test passes, the story is done. Nothing
more is needed. See the book I referenced above.
Anything else you need can be gotten from some other methodology, and
ruthlessly pared down to essentials. The emphasis is on the ruthless.
HTH
John Roth
| |
|
|
|
|
|
|
|
|
|
|
|