File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

tests as documentation?

 
Jeff Langr
author
Ranch Hand
Posts: 799
5
  • 0
  • 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.
 
Janet Gregory
Author
Ranch Hand
Posts: 31
  • 0
  • 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
Ranch Hand
Posts: 799
5
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
thanks Janet!
 
Lisa Crispin
Ranch Hand
Posts: 43
  • 0
  • 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
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic