Documentation by Example (original) (raw)

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.

Similar content being viewed by others

References

Author information

Authors and Affiliations

  1. Agical AB, Västerlanggatan 79, Stockholm, Sweden
    Daniel Brolund

Editor information

Editors and Affiliations

  1. Department of Computer Science, University of Helsinki, P.O.Box 68, 00014, Helsinki, Finland
    Pekka Abrahamsson
  2. DIEE Department of Electrical and Electronic Engineering, University of Cagliari, Cagliari, Sardinia, Italy
    Michele Marchesi
  3. Agile Software Engineering/e-Business Engineering (ase/ebe) group, University of Calgary, Calgary, Canada
    Frank Maurer

Rights and permissions

© 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

Keywords

Publish with us