INTERCONNECTING DOCUMENTATION - Harnessing the Different Powers of Current Documentation Tools in Software Development

Christian Prause, Julia Kuck, Stefan Apelt, Reinhard Oppermann, Armin B. Cremers

Abstract

Current software documentation tools (like text processors, email, documentation generators, reporting, configuration management, wikis) have different strengths in supporting the software engineering process. But one weakness they all have in common is their inability to combine the advantages of the various techniques. Integrating documentation with diverse origins would enhance the force of expression and compensate individual failings of the different techniques. In this paper, we present a new brand of documentation utilities — exemplified by the Dendrodoc-system — that overcomes current problems with documentation. By processing information at negligible cost that common tools ignore, our system represents an efficient way of improving software documentation.

References

  1. Balzert, H. (1988). Ökonomische software-wartung durch adäquate software-konstruktion. In Wix, B. and Balzert, H., editors, Softwarewartung. BI Wissenschaftsverlag.
  2. Becker, J., Janiesch, C., Delfmann, P., and Fuhr, W. (2005). Perspectives on process documentation - a case study. In ICEIS (3).
  3. Didrich, K. and Klein, T. (1996). A pragmatic approach to software documentation. Technical Report 4, Technische Universität Berlin.
  4. Ericsson, K. A. and Simon, H. A. (1980). Verbal reports as data. In Psychological Review, 87(3).
  5. ISO 13407 (1999). Human-centered design processes for interactive systems. In ISO/TC 159 Ergonomics, ISO International Organization for Standardization ISO 13407 (E).
  6. Kirsch, S. M., Gnasa, M., and Cremers, A. B. (2006). Beyond the Web: Retrieval in Social Information Spaces. In Proceedings of the 28th European Conference on Information Retrieval (ECIR 2006), vol. 3936 of Lecture Notes on Computer Science, Berlin. Springer Verlag.
  7. Krahmer, E. and Ummelen, N. (2004). Thinking about thinking aloud: A comparison of two verbal protocols for usability testing. In IEEE Transactions on Professional Communication, 47(2).
  8. Lehner, F. (1993). Quality control in software documentation based on measurement of text comprehension and text comprehensibility. Inf. Process. Manage., 29(5).
  9. Lethbridge, T. C., Singer, J., and Forward, A. (2003). How software engineers use documentation: The state of the practice. IEEE Software, 20(6).
  10. Malone, T. W. and Crowston, K. (1994). The interdisciplinary study of coordination. ACM Comput. Surv., 26(1).
  11. Opperman, R. and Reiterer, H. (1997). Software evaluation using the 9241 evaluator. Behaviour and Information Technology, 16(4/5):232-245.
  12. Prause, C. (2006). Design und evaluation von dokumentations- und qualitätssicherungsmethoden am beispiel der fit-lernplattform. Master's thesis, Rheinische Friedrich-Wilhelms-Universität, Bonn.
  13. Pressman, R. S. (2001). Software Engineering: A Practitioner's Approach. McGraw-Hill.
  14. Seddon, J. (1997). In Persuit of Quality: The Case Against ISO 9000. Oak Tree Press.
  15. Tellioglu, H. (2004). CoMex - a mechanism for coordination of task execution in group work. In Cordeiro, J. and Filipe, J., editors, Computer Supported Activity Coordination, In conjunction with ICEIS 2004. INSTICC Press.
  16. van Deusen, A. and Kuipers, T. (1999). Building documentation generators. In Proceedings IEEE International Conference on Software Maintenance 1999 (ICSM'99). IEEE.
  17. Vestdam, T. and Nørmark, K. (2005). Toward documentation of program evolution. In Proceedings of the 21st IEEE International Conference on Software Maintenance (ICSM'05). IEEE.
Download


Paper Citation


in Harvard Style

Prause C., Kuck J., Apelt S., Oppermann R. and B. Cremers A. (2007). INTERCONNECTING DOCUMENTATION - Harnessing the Different Powers of Current Documentation Tools in Software Development . In Proceedings of the Ninth International Conference on Enterprise Information Systems - Volume 2: ICEIS, ISBN 978-972-8865-89-4, pages 63-68. DOI: 10.5220/0002375200630068


in Bibtex Style

@conference{iceis07,
author={Christian Prause and Julia Kuck and Stefan Apelt and Reinhard Oppermann and Armin B. Cremers},
title={INTERCONNECTING DOCUMENTATION - Harnessing the Different Powers of Current Documentation Tools in Software Development},
booktitle={Proceedings of the Ninth International Conference on Enterprise Information Systems - Volume 2: ICEIS,},
year={2007},
pages={63-68},
publisher={SciTePress},
organization={INSTICC},
doi={10.5220/0002375200630068},
isbn={978-972-8865-89-4},
}


in EndNote Style

TY - CONF
JO - Proceedings of the Ninth International Conference on Enterprise Information Systems - Volume 2: ICEIS,
TI - INTERCONNECTING DOCUMENTATION - Harnessing the Different Powers of Current Documentation Tools in Software Development
SN - 978-972-8865-89-4
AU - Prause C.
AU - Kuck J.
AU - Apelt S.
AU - Oppermann R.
AU - B. Cremers A.
PY - 2007
SP - 63
EP - 68
DO - 10.5220/0002375200630068