Skip to main content

Abstract

Writing documentation can be fun and rewarding, but keeping up with an ever-changing system can take a toll on that joy. The documentation tends to get either expensive (duplication-intense), outdated or non-existing. This demonstration will present an open source tool that addresses these shortcomings by extending the BDD[1] approach to provide rich and human readable documents automatically from a JUnit[2] test suite. You’ll learn how to include snippets, run-time data and more in your documents, all this with minimal effort and intrusion. This approach is suitable both for APIs and GUIs, as will be shown.

This is a preview of subscription content, log in via an institution to check access.

Access this chapter

Chapter
USD 29.95
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
eBook
USD 39.99
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 54.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Author information

Authors and Affiliations

Authors

Editor information

Editors and Affiliations

Rights and permissions

Reprints and permissions

Copyright information

© 2009 Springer-Verlag Berlin Heidelberg

About this paper

Cite this paper

Brolund, D. (2009). Documentation by Example. In: Abrahamsson, P., Marchesi, M., Maurer, F. (eds) Agile Processes in Software Engineering and Extreme Programming. XP 2009. Lecture Notes in Business Information Processing, vol 31. Springer, Berlin, Heidelberg. https://doi.org/10.1007/978-3-642-01853-4_54

Download citation

  • DOI: https://doi.org/10.1007/978-3-642-01853-4_54

  • Publisher Name: Springer, Berlin, Heidelberg

  • Print ISBN: 978-3-642-01852-7

  • Online ISBN: 978-3-642-01853-4

  • eBook Packages: Computer ScienceComputer Science (R0)

Publish with us

Policies and ethics