Skip to main content
Top

2018 | OriginalPaper | Chapter

Agile Documentation Tool Concept

Authors : Stefan Voigt, Detlef Hüttemann, Andreas Gohr, Michael Große

Published in: Developments and Advances in Intelligent Systems and Applications

Publisher: Springer International Publishing

Activate our intelligent search to find suitable subject content or patents.

search-config
loading …

Abstract

Documentation is often neglected in agile software projects, even if software developers perceive a need for good documentation. One reason can be found in improper documentation tools. This paper provides an overview of the central conceptual ideas for an agile documentation tool.

Dont have a licence yet? Then find out more about our products and how to get one now:

Springer Professional "Wirtschaft+Technik"

Online-Abonnement

Mit Springer Professional "Wirtschaft+Technik" erhalten Sie Zugriff auf:

  • über 102.000 Bücher
  • über 537 Zeitschriften

aus folgenden Fachgebieten:

  • Automobil + Motoren
  • Bauwesen + Immobilien
  • Business IT + Informatik
  • Elektrotechnik + Elektronik
  • Energie + Nachhaltigkeit
  • Finance + Banking
  • Management + Führung
  • Marketing + Vertrieb
  • Maschinenbau + Werkstoffe
  • Versicherung + Risiko

Jetzt Wissensvorsprung sichern!

Springer Professional "Technik"

Online-Abonnement

Mit Springer Professional "Technik" erhalten Sie Zugriff auf:

  • über 67.000 Bücher
  • über 390 Zeitschriften

aus folgenden Fachgebieten:

  • Automobil + Motoren
  • Bauwesen + Immobilien
  • Business IT + Informatik
  • Elektrotechnik + Elektronik
  • Energie + Nachhaltigkeit
  • Maschinenbau + Werkstoffe




 

Jetzt Wissensvorsprung sichern!

Springer Professional "Wirtschaft"

Online-Abonnement

Mit Springer Professional "Wirtschaft" erhalten Sie Zugriff auf:

  • über 67.000 Bücher
  • über 340 Zeitschriften

aus folgenden Fachgebieten:

  • Bauwesen + Immobilien
  • Business IT + Informatik
  • Finance + Banking
  • Management + Führung
  • Marketing + Vertrieb
  • Versicherung + Risiko




Jetzt Wissensvorsprung sichern!

Footnotes
1
We identified this landscape among our pilot users and in our study. At least two thirds of all companies surveyed use the tools listed (92% IDE, 90% VCS, 80% issue trackers, 68% wikis). Our study’s pilot user and respondents also communicated need for integration with issue trackers, VCS and IDE [33].
 
2
CosmoCode developed the widely used DokuWiki (www.​dokuwiki.​org) wiki engine on which we based our prototype.
 
3
We chose Atlassian JIRA for our prototype and for use in our pilot user environments because it has been widely adopted [29].
 
4
The sprintDoc prototype is connected with the GitLab VCS for the same reasons.
 
Literature
3.
go back to reference Abrahamsson, P., Conboy, K., Wang, X.: Lots done, more to do’: the current state of agile systems development research. Eur. J. Inf. Syst. 18, 281–284 (2009)CrossRef Abrahamsson, P., Conboy, K., Wang, X.: Lots done, more to do’: the current state of agile systems development research. Eur. J. Inf. Syst. 18, 281–284 (2009)CrossRef
4.
go back to reference Ambler, S.W.: Agile Modeling: Effective Practices for Extreme Programming and the Unified Process. Wiley, New York (2002) Ambler, S.W.: Agile Modeling: Effective Practices for Extreme Programming and the Unified Process. Wiley, New York (2002)
6.
go back to reference Cohen, D., Lindvall, M., Costa, P.: Agile Software Development. New York (2003) Cohen, D., Lindvall, M., Costa, P.: Agile Software Development. New York (2003)
7.
go back to reference Conboy, K., Morgan, L.: Future research in agile systems development: applying open innovation principles within the agile organisation. In: Dingsøyr, T., Dybå, T., Moe, N.B. (eds.) Agile Software Development, pp. 223–235. Springer, Berlin, Heidelberg (2010)CrossRef Conboy, K., Morgan, L.: Future research in agile systems development: applying open innovation principles within the agile organisation. In: Dingsøyr, T., Dybå, T., Moe, N.B. (eds.) Agile Software Development, pp. 223–235. Springer, Berlin, Heidelberg (2010)CrossRef
8.
go back to reference Dingsøyr, T., Dybå, T., Moe, N.B.: Agile software development: an introduction and overview. In: Dingsøyr, T., Dybå, T., Moe, N.B. (eds.) Agile Software Development. Springer, Berlin, Heidelberg, pp. 1–13 (2010) Dingsøyr, T., Dybå, T., Moe, N.B.: Agile software development: an introduction and overview. In: Dingsøyr, T., Dybå, T., Moe, N.B. (eds.) Agile Software Development. Springer, Berlin, Heidelberg, pp. 1–13 (2010)
9.
go back to reference Dingsøyr, T., Nerur, S., Balijepally, V.G., Moe, N.B.: A decade of agile methodologies: towards explaining agile software development. J. Syst. Softw. 85, 1213–1221 (2012). doi:10.1016/j.jss.2012.02.033 Dingsøyr, T., Nerur, S., Balijepally, V.G., Moe, N.B.: A decade of agile methodologies: towards explaining agile software development. J. Syst. Softw. 85, 1213–1221 (2012). doi:10.​1016/​j.​jss.​2012.​02.​033
11.
go back to reference Glass, R.L.: Agile versus traditional: make love, not war! Cut. IT J. 14, 12–18 (2001) Glass, R.L.: Agile versus traditional: make love, not war! Cut. IT J. 14, 12–18 (2001)
12.
go back to reference Gregor, S., Hevner, A.R.: Positioning and presenting design science research for maximum impact. MIS Quaterly 37, 337–356 (2013) Gregor, S., Hevner, A.R.: Positioning and presenting design science research for maximum impact. MIS Quaterly 37, 337–356 (2013)
13.
go back to reference Gröber, M.: Investigation of the Usage of Artifacts in Agile Methods. Master Thesis, Munich (2013) Gröber, M.: Investigation of the Usage of Artifacts in Agile Methods. Master Thesis, Munich (2013)
14.
go back to reference Hadar, I., Sherman, S., Hadar, E., Harrison, J.J.: Less is more: architecture documentation for agile development. In: Prikladnicki, R., Hoda, R., Cataldo, M., Sharp, H., Dittrich, Y., de Souza, C. (eds.) 6th International Workshop on Cooperative and Human Aspects of Software Engineering (CHASE), pp. 121–124 (2013) Hadar, I., Sherman, S., Hadar, E., Harrison, J.J.: Less is more: architecture documentation for agile development. In: Prikladnicki, R., Hoda, R., Cataldo, M., Sharp, H., Dittrich, Y., de Souza, C. (eds.) 6th International Workshop on Cooperative and Human Aspects of Software Engineering (CHASE), pp. 121–124 (2013)
15.
go back to reference Hevner, A.R., March, S.T., Park, J., Ram, S.: Design science in information systems research. MIS Quaterly 28, 75–105 (2004) Hevner, A.R., March, S.T., Park, J., Ram, S.: Design science in information systems research. MIS Quaterly 28, 75–105 (2004)
17.
go back to reference Kanwal, F., Bashir, K., Ali, A.H.: Documentation practices for offshore agile software development. Life Sci. J. 10, 70–73 (2014) Kanwal, F., Bashir, K., Ali, A.H.: Documentation practices for offshore agile software development. Life Sci. J. 10, 70–73 (2014)
18.
19.
go back to reference Myklebust, T., Stålhaneb, T., Hanssena, G.K., Wienc, T., Haugseta, B.: Scrum, documentation and the IEC 61508-3:2010 software standard. In: Proceedings of the Probabilistic Safety Assessment and Management (2014) Myklebust, T., Stålhaneb, T., Hanssena, G.K., Wienc, T., Haugseta, B.: Scrum, documentation and the IEC 61508-3:2010 software standard. In: Proceedings of the Probabilistic Safety Assessment and Management (2014)
20.
go back to reference Peffers, K., Tuunanen, T., Rothenberger, M.A., Chatterjee, S.: A design science research methodology for information systems research. J. Manag. Inf. Syst. 24, 45–77 (2007). doi:10.2753/MIS0742-1222240302 Peffers, K., Tuunanen, T., Rothenberger, M.A., Chatterjee, S.: A design science research methodology for information systems research. J. Manag. Inf. Syst. 24, 45–77 (2007). doi:10.​2753/​MIS0742-1222240302
21.
go back to reference Prause, C.R., Durdik, Z.: Architectural design and documentation: waste in agile development? In: Jeffery, R., Raffo, D., Armbrust, O., Huang, L. (eds.) Proceedings of the 2012 International Conference on Software and System Process (ICSSP), pp. 130–134 (2012) Prause, C.R., Durdik, Z.: Architectural design and documentation: waste in agile development? In: Jeffery, R., Raffo, D., Armbrust, O., Huang, L. (eds.) Proceedings of the 2012 International Conference on Software and System Process (ICSSP), pp. 130–134 (2012)
23.
go back to reference Rüping, A.: Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects. Wiley, Hoboken, NJ (2003) Rüping, A.: Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects. Wiley, Hoboken, NJ (2003)
25.
go back to reference Silveira, C., Faria, J.P., Aguiar, A., Vidal, R.: Wiki based requirements documentation of generic software products In: Proceedings of the 10th Australian Workshop on Requirements Engineering (AWRE’2005), pp. 42–51 (2005) Silveira, C., Faria, J.P., Aguiar, A., Vidal, R.: Wiki based requirements documentation of generic software products In: Proceedings of the 10th Australian Workshop on Requirements Engineering (AWRE’2005), pp. 42–51 (2005)
26.
go back to reference Stettina, C.J., Heijstek, W.: Necessary and neglected?: an empirical study of internal documentation in agile software development teams. In: Protopsaltis, A., Spyratos, N., Costa, C.J., Meghini, C. (eds.) Proceedings of the 29th ACM international conference on Design of communication, pp. 159–166 (2011) Stettina, C.J., Heijstek, W.: Necessary and neglected?: an empirical study of internal documentation in agile software development teams. In: Protopsaltis, A., Spyratos, N., Costa, C.J., Meghini, C. (eds.) Proceedings of the 29th ACM international conference on Design of communication, pp. 159–166 (2011)
27.
go back to reference Stettina, C.J., Heijstek, W., Faegri, T.E.: Documentation work in agile teams: the role of documentation formalism in achieving a sustainable practice. In: IEEE Computer Society (ed.) Proceedings-2012 Agile Conference, pp. 31–40 (2012) Stettina, C.J., Heijstek, W., Faegri, T.E.: Documentation work in agile teams: the role of documentation formalism in achieving a sustainable practice. In: IEEE Computer Society (ed.) Proceedings-2012 Agile Conference, pp. 31–40 (2012)
28.
go back to reference Stettina, C.J., Kroon, E.: Is there an agile handover? an empirical study of documentation and project handover practices across agile software teams. In: 2013 International Conference on Engineering, Technology and Innovation (ICE) & IEEE International Technology Management Conference (2013) Stettina, C.J., Kroon, E.: Is there an agile handover? an empirical study of documentation and project handover practices across agile software teams. In: 2013 International Conference on Engineering, Technology and Innovation (ICE) & IEEE International Technology Management Conference (2013)
29.
go back to reference Tripathi, V., Goyal, A.K.: A document driven approach for agile software development. IJARCSSE 4, 1085–1090 (2014) Tripathi, V., Goyal, A.K.: A document driven approach for agile software development. IJARCSSE 4, 1085–1090 (2014)
30.
go back to reference Uikey, N., Suman, U., Ramani, A.K.: A documented approach in agile software development. IJSE 2, 13–22 (2011) Uikey, N., Suman, U., Ramani, A.K.: A documented approach in agile software development. IJSE 2, 13–22 (2011)
32.
go back to reference Voigt, S., Fuchs-Kittowski, F., Gohr, A.: Structured wikis: application oriented use cases. In: Proceedings of the 10th International Symposium on Open Collaboration. ACM, New York (2014) Voigt, S., Fuchs-Kittowski, F., Gohr, A.: Structured wikis: application oriented use cases. In: Proceedings of the 10th International Symposium on Open Collaboration. ACM, New York (2014)
33.
go back to reference Voigt, S., von Garrel, J., Müller, J., Wirth, D.: A study of documentation in agile software projects. In: Proceedings of the 10th ACM/IEEE International Symposium on Empirical Software Engineering and Measurement. ACM, New York (2016) Voigt, S., von Garrel, J., Müller, J., Wirth, D.: A study of documentation in agile software projects. In: Proceedings of the 10th ACM/IEEE International Symposium on Empirical Software Engineering and Measurement. ACM, New York (2016)
34.
go back to reference Voigt, S., Hüttemann, D., Gohr, A.: sprintDoc: concept for an agile documentation tool. In: Rocha, A., Reis, L.P., Cota, M.P., Suárez, O.S., Gonçalves, R. (eds.) Sistemas y Tecnologías de Información, pp. 1146–1149 (2016) Voigt, S., Hüttemann, D., Gohr, A.: sprintDoc: concept for an agile documentation tool. In: Rocha, A., Reis, L.P., Cota, M.P., Suárez, O.S., Gonçalves, R. (eds.) Sistemas y Tecnologías de Información, pp. 1146–1149 (2016)
Metadata
Title
Agile Documentation Tool Concept
Authors
Stefan Voigt
Detlef Hüttemann
Andreas Gohr
Michael Große
Copyright Year
2018
DOI
https://doi.org/10.1007/978-3-319-58965-7_5

Premium Partner