Do we Really Need to Write Documentation for a System? - CASE Tool Add-ons: Generator+Editor for a Precise Documentation

Maria Spichkova, Xiuna Zhu, Dongyue Mou

Abstract

One of the common problems of system development projects is that the system documentation is often outdated and does not describe the latest version of the system. The situation is even more complicated if we are speaking not about a natural language description of the system, but about its formal specification. In this paper we discuss how the problem could be solved by updating the documentation automatically, by generating a new formal specification from the model if the model is frequently changed.

References

  1. Abrial, J.-R. (1996). The B-book: assigning programs to meanings. Camb.Univ.Press.
  2. Broy, M. and Stølen, K. (2001). Specification and Development of Interactive Systems: FOCUS on Streams, Interfaces, and Refinement. Springer.
  3. Campetelli, A., Hö lzl, F., and Neubeck, P. (2011). Userfriendly model checking integration in model-based development. In The Twenty-Fourth International Conference on Computer Applications in Industry and Engineering (CAINE 2011), Honolulu, Hawaii, USA. The International Society for Computers and Their Applications.
  4. Feilkas, M., Fleischmann, A., Hö lzl, F., Pfaller, C., Rittmann, S., Scheidemann, K., Spichkova, M., and Trachtenherz, D. (2009). A Top-Down Methodology for the Development of Automotive Software. Technical Report TUM-I0902, TU Mü nchen.
  5. Feilkas, M., Hö lzl, F., Pfaller, C., Rittmann, S., Schätz, B., Schwitzer, W., Sitou, W., Spichkova, M., and Trachtenherz, D. (2011). A Refined Top-Down Methodology for the Development of Automotive Software Systems - The KeylessEntry-System Case Study. Technical Report TUM-I1103, TU Mü nchen.
  6. Hö lzl, F. and Feilkas, M. (2010). Autofocus 3: a scientific tool prototype for model-based development of component-based, reactive, distributed systems. In Proceedings of the 2007 International Dagstuhl conference on Model-based engineering of embedded real-time systems, MBEERTS'10, pages 317-322.
  7. Nipkow, T., Paulson, L. C., and Wenzel, M. (2002). Isabelle/HOL - A Proof Assistant for Higher-Order Logic, volume 2283 of LNCS. Springer.
  8. Schätz, B. (2004). Mastering the Complexity of Reactive Systems: the AUTOFOCUS Approach. In Kordon, F. and Lemoine, M., editors, Formal Methods for Embedded Distributed Systems: How to Master the Complexity, pages 215-258. Kluwer Academic Publishers.
  9. Schätz, B. and Huber, F. (1999). Integrating Formal Description Techniques. In Wing, J. M., Woodcock, J., and Davies, J., editors, FM'99, volume 1709 of LNCS, pages 1206-1225. Springer.
  10. Spichkova, M. (2007). Specification and Seamless Verification of Embedded Real-Time Systems: FOCUS on Isabelle. PhD thesis, TU Mü nchen.
  11. Spichkova, M. (2011). Focus on processes. Tech. Report TUM-I1115, TU M ünchen.
  12. Spichkova, M. (2012a). Focus on Time. In In Proceedings of the 12th International Workshop on Automated Verification of Critical Systems (AVoCS 2012).
  13. Spichkova, M. (2012b). Human Factors of Formal Methods. In In IADIS Interfaces and Human Computer Interaction 2012 (IHCI 2012).
  14. Spichkova, M., Hö lzl, F., and Trachtenherz, D. (2012). Verified System Development with the AutoFocus Tool Chain. In 2nd Workshop on Formal Methods in the Development of Software, WS-FMDS.
  15. Spivey, M. (1988). Understanding Z - A Specification Language and Its Formal Semantics. Cambridge Tracts in Theoretical Computer Science 3. Camb. Univ. Press.
  16. Thyssen, J., Ratiu, D., Schwitzer, W., Harhurin, A., Feilkas, M., and Thaden, E. (2010). A System for Seamless Abstraction Layers for Model-based Development of Embedded Software. In Software Engineering, SE'10.
Download


Paper Citation


in Harvard Style

Spichkova M., Zhu X. and Mou D. (2013). Do we Really Need to Write Documentation for a System? - CASE Tool Add-ons: Generator+Editor for a Precise Documentation . In Proceedings of the 1st International Conference on Model-Driven Engineering and Software Development - Volume 1: MODELSWARD, ISBN 978-989-8565-42-6, pages 170-174. DOI: 10.5220/0004347101700174


in Bibtex Style

@conference{modelsward13,
author={Maria Spichkova and Xiuna Zhu and Dongyue Mou},
title={Do we Really Need to Write Documentation for a System? - CASE Tool Add-ons: Generator+Editor for a Precise Documentation},
booktitle={Proceedings of the 1st International Conference on Model-Driven Engineering and Software Development - Volume 1: MODELSWARD,},
year={2013},
pages={170-174},
publisher={SciTePress},
organization={INSTICC},
doi={10.5220/0004347101700174},
isbn={978-989-8565-42-6},
}


in EndNote Style

TY - CONF
JO - Proceedings of the 1st International Conference on Model-Driven Engineering and Software Development - Volume 1: MODELSWARD,
TI - Do we Really Need to Write Documentation for a System? - CASE Tool Add-ons: Generator+Editor for a Precise Documentation
SN - 978-989-8565-42-6
AU - Spichkova M.
AU - Zhu X.
AU - Mou D.
PY - 2013
SP - 170
EP - 174
DO - 10.5220/0004347101700174