• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Liutauras Vilda
  • Tim Cooke
  • Jeanne Boyarsky
  • Bear Bibeault
Sheriffs:
  • Knute Snortum
  • paul wheaton
  • Devaka Cooray
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Ron McLeod
  • Piet Souris
  • Ganesh Patekar
Bartenders:
  • Tim Holloway
  • Carey Brown
  • salvin francis

tests as documentation?

 
author
Posts: 799
5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Greetings authors--

How do you feel about the use of agile tests as a form of documentation, and does the book emphasize how one might best do this?

thanks,
Jeff L.
 
Author
Posts: 31
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Jeff,

I am a personal fan of using tests as documentation. It really is the only way we can guarantee that the documentation is up to date. Of course, that assumes that your tests all run succussfully

The book does not specifically address how to do that because each tool is different. The easiest way is to name your tests very distinctly, and make sure each test has one specific purpose. Test management is very important so that you can actually retrieve the information you need when you need it.

Janet
 
Jeff Langr
author
Posts: 799
5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
thanks Janet!
 
Ranch Hand
Posts: 43
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

Jeff Langr wrote:Greetings authors--

How do you feel about the use of agile tests as a form of documentation, and does the book emphasize how one might best do this?

thanks,
Jeff L.


Hi Jeff,
Just to add to Janet's answer - we have a small section in the book titled "Tests Are Great Documentation". My team has had good success using FitNesse tests as "living" documentation of how the system actually works. We might get lazy about keeping static written docs up to date, but when the FitNesse tests fail, we have to fix them and keep our build "green".

We were heavily influenced by Brian Marick's emphasis on using examples to create tests and drive coding, and we emphasize the use of examples in the book also.
-- Lisa
 
Hang a left on main. Then read this tiny ad:
professionally read, modify and write PDF files from Java
https://products.aspose.com/pdf/java
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!