Lido – Wiki based Living Documentation with Domain Knowledge

Reuven Yagel

Abstract

There is a gap between code and documentation in many software development projects. This gap usually grows as time goes by, decreasing developers ability to keep product quality high. We describe how documentation based on a common wiki can be enhanced with domain knowledge in ways that ensure better live documentation. This way updated and relevant documentation, i.e., specifications, manuals, models, test scripts, etc. lead ultimately to higher quality software.

References

  1. Adzic, G., 2008. Test Driven .NET Development with FitNesse, Neuri, London, UK.
  2. Adzic, G., 2009. Bridging the Communication Gap: Specification by Example and Agile Acceptance Testing, Neuri, London, UK.
  3. Adzic, G., 2011. Specification by Example - How Successful Teams Deliver the Right Software, Manning, New York, USA.
  4. ArgoUML. Available from: http://argouml.tigris.org/. [29 September 2015].
  5. BDDfy. Available from: https://github.com/ TestStack/TestStack.BDDfy. [29 September 2015].
  6. Brown, K., 2011. Taking executable specs to the next level: Executable Documentation, Available from: http://keithps.wordpress.com/2011/06/26/takingexecutable-specs-to-the-next-level-executabledocumentation/. [1 September 2011].
  7. DaSpec. Available from: http://daspec.com/. [29 September 2015].
  8. Evans E., 2003. Domain-Driven Design: Tackling Complexity in the Heart of Software. Prentice Hall.
  9. Exman I., Litovka, A. and Yagel, R., 2014. Ontologies + Mock Objects = Runnable Knowledge, the 5th International Conference on Knowledge Discovery, Knowledge Engineering and Knowledge Management (IC3K) - SKY Workshop, Rome, Italy.
  10. Feathers M., 2004. Working Effectively with Legacy Code. Prentice Hall, 2004.
  11. Fowler M., 2003. UML distilled, 3rd ed., Addison Wesley.
  12. Github. Available from: https://github.com/. [29 September 2015].
  13. Graphviz. Available from: http://www.graphviz.org/. [29 September 2015].
  14. Krötzsch M., Vrandecic D., Völkel M., Haller H., Studer R., 2007. Semantic Wikipedia. In Journal of Web Semantics 5/2007, pp. 251-261. Elsevier.
  15. IBM. Rational Team Concert. Available from: http://www-03.ibm.com/software/products/en/rtc. [29 September 2015].
  16. Mapador. Available from: http://www.mapador.com/ documentation/. [29 September 2015].
  17. Martraire C., 2016. Living Documentation - A low-effort approach of Documentation that is always up-to-date, inspired by Domain-Driven Design. Leanpub (expected). http://leanpub.com/livingdocumentation.
  18. MediaWiki. Available from: https://www.mediawiki.org/. [29 September 2015].
  19. North, D., 2006. Introducing Behaviour Driven Development, Better Software Magazine. Available from: http://dannorth.net/introducing-bdd/. [29 September 2015].
  20. Osetinsky I, and Yagel, R., 2014. Working More Effectively with Legacy Code Using Domain Knowledge and Abstractions - A Case Study, the 5th International Conference on Knowledge Discovery, Knowledge Engineering and Knowledge Management (IC3K) - SKY Workshop, Rome, Italy.
  21. Smart J. F., 2014. BDD in Action Behavior-Driven Development for the whole software lifecycle, Manning.
  22. SpecFlow. Pragmatic BDD for .NET. Available from: http://specflow.org. [29 September 2015].
  23. Wynne, M. and Hellesoy, A., 2012. The Cucumber Book: Behaviour Driven Development for Testers and Developers, Pragmatic Programmer, New York.
  24. Wikipedia. Available from: https://en.wikipedia.org/wiki/Wiki. [29 September 2015].
  25. Yagel, R., 2011. Can Executable Specifications Close the Gap between Software Requirements and Implementation?, pp. 87-91, in Exman, I., Llorens, J. and Fraga, A. (eds.), Proc. SKY'2011 Int. Workshop on Software Engineering, SciTePress, Portugal.
  26. Yagel, R., Litovka, A. and Exman I., 2013: KoDEgen: A Knowledge Driven Engineering Code Generating Tool, The 4th International Conference on Knowledge Discovery, Knowledge Engineering and Knowledge Management (IC3K) - SKY Workshop, Vilamoura, Portugal.
Download


Paper Citation


in Harvard Style

Yagel R. (2015). Lido – Wiki based Living Documentation with Domain Knowledge . In Proceedings of the 6th International Workshop on Software Knowledge - Volume 1: SKY, (IC3K 2015) ISBN 978-989-758-162-5, pages 22-26. DOI: 10.5220/0005643700220026


in Bibtex Style

@conference{sky15,
author={Reuven Yagel},
title={Lido – Wiki based Living Documentation with Domain Knowledge},
booktitle={Proceedings of the 6th International Workshop on Software Knowledge - Volume 1: SKY, (IC3K 2015)},
year={2015},
pages={22-26},
publisher={SciTePress},
organization={INSTICC},
doi={10.5220/0005643700220026},
isbn={978-989-758-162-5},
}


in EndNote Style

TY - CONF
JO - Proceedings of the 6th International Workshop on Software Knowledge - Volume 1: SKY, (IC3K 2015)
TI - Lido – Wiki based Living Documentation with Domain Knowledge
SN - 978-989-758-162-5
AU - Yagel R.
PY - 2015
SP - 22
EP - 26
DO - 10.5220/0005643700220026