Skip to main content

A Stakeholder-Centric Optimization Strategy for Architectural Documentation

  • Conference paper
Model and Data Engineering (MEDI 2013)

Part of the book series: Lecture Notes in Computer Science ((LNPSE,volume 8216))

Included in the following conference series:

Abstract

The Software Architecture is an important asset in a software development process, which serves to share and discuss the main design concerns among the project stakeholders. The architecture knowledge must be properly documented in order to be effectively used by these stakeholders (e.g., using a Wiki). However, the repository of architectural documents usually fails to satisfy the stakeholder’s information needs. There are several reasons for this mismatch, namely: documentation efforts not perceived as valuable, little consideration of potential documentation consumers, or documentation generated in one single step but “late” in the lifecycle, among others. Therefore, the value of the architecture as a means for engaging stakeholders and articulating their goals within the project is diminished. To address the problem, we argue for a knowledge management strategy in which: (i) architecture documentation is created incrementally; and (ii) its contents are driven by a model of stakeholder preferences. In this work, we present an information optimization approach applied to the architecture documentation domain, derived from an existing documentation method. Specifically, we propose a tool that recommends a satisficing set of (documentation) tasks for delivering architectural contents that address the main stakeholder’s needs. A preliminary evaluation of our approach has shown its potential for cost-effective information management.

This is a preview of subscription content, log in via an institution to check access.

Access this chapter

Chapter
USD 29.95
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
eBook
USD 39.99
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 54.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Preview

Unable to display preview. Download preview PDF.

Unable to display preview. Download preview PDF.

References

  1. Bachmann, F., Merson, P.: Experience using the web-based tool wiki for architecture documentation. Technical Note CMU/SEI-2005-TN-041, Software Engineering Institute, Carnegie Mellon University (2005)

    Google Scholar 

  2. Bass, L., Clements, P., Kazman, R.: Software Architecture in Practice, 3rd edn. Addison-Wesley Professional (2012)

    Google Scholar 

  3. Clements, P., Bachmann, F., Bass, L., Garlan, D., Ivers, J., Little, R., Merson, P., Nord, R., Stafford, J.: Documenting Software Architectures: Views and Beyond, 2nd edn. Addison-Wesley Professional (2010)

    Google Scholar 

  4. de Graaf, K.A., Tang, A., Liang, P., van Vliet, H.: Ontology-based software architecture documentation. In: Proceedings Joint Working Conf. on Software Architecture & European Conf. on Software Architecture (WICSA/ECSA), WICSA 2012, pp. 315–319. IEEE Computer Society (2012)

    Google Scholar 

  5. Farenhorst, R., van Vliet, H.: Experiences with a wiki to support architectural knowledge sharing. In: Proceedings of the 3rd Workshop on Wikis for Software Engineering (Wiki4SE), Porto, Portugal (September 2008)

    Google Scholar 

  6. Hofmeister, C., Nord, R., Soni, D.: Applied Software Architecture, 1st edn. Addison-Wesley Professional (2000)

    Google Scholar 

  7. ISO/IEC/IEEE: Iso/iec/ieee 42010: Systems and software engineering - architecture description (2011)

    Google Scholar 

  8. Jansen, A., Avgeriou, P., van der Ven, J.S.: Enriching software architecture documentation. Journal of Systems and Software 82(8), 1232–1248 (2009)

    Article  Google Scholar 

  9. Jansen, A., Bosch, J.: Software architecture as a set of architectural design decisions. In: Proceedings Working Conf. on Software Architecture, pp. 109–120. IEEE Computer Society (2005)

    Google Scholar 

  10. Koning, H., Vliet, H.V.: Real-life it architecture design reports and their relation to ieee std 1471 stakeholders and concerns. Automated Software Eng. 13, 201–223 (2006)

    Article  Google Scholar 

  11. Kruchten, P.: The 4+1 view model of architecture. IEEE Software 12(6), 42–50 (1995)

    Article  Google Scholar 

  12. Lattanze, A.: Architecting Software Intensive Systems: A Practitioners Guide. Taylor & Francis (2008)

    Google Scholar 

  13. Mitchell, R.K., Agle, B.R., Wood, D.J.: Toward a theory of stakeholder identification and salience: Defining the principle of who and what really counts. Academy of Management Review 22, 853 (1997)

    Google Scholar 

  14. Nicoletti, M., Diaz-Pace, J.A., Schiaffino, S.: Towards software architecture documents matching stakeholders’ interests. In: Cipolla-Ficarra, F., Veltman, K., Verber, D., Cipolla-Ficarra, M., Kammüller, F. (eds.) ADNTIIC 2011. LNCS, vol. 7547, pp. 176–185. Springer, Heidelberg (2012)

    Chapter  Google Scholar 

  15. Nicoletti, M., Diaz-Pace, J.A., Schiaffino, S.: Discovering stakeholders’ interests in wiki-based architectural documentation. In: Proceedings of the XVI Ibero-American Conference on Software Engineering, CibSE (2013)

    Google Scholar 

  16. Parnas, D.L.: Precise documentation: The key to better software. In: Nanz, S. (ed.) The Future of Software Engineering, pp. 125–148. Springer (2010)

    Google Scholar 

  17. Pisinger, D.: A minimal algorithm for the multiple-choice knapsack problem. European Journal of Operational Research 83, 394–410 (1995)

    Article  MATH  Google Scholar 

  18. Rozanski, N., Woods, E.: Software Systems Architecture: Working With Stakeholders Using Viewpoints and Perspectives, 2nd edn. Addison-Wesley (2011)

    Google Scholar 

  19. Su, M.T.: Capturing exploration to improve software architecture documentation. In: Proceedings 4th European Conf. on Software Architecture: Companion Volume, ECSA 2010, pp. 17–21. ACM, New York (2010)

    Google Scholar 

Download references

Author information

Authors and Affiliations

Authors

Editor information

Editors and Affiliations

Rights and permissions

Reprints and permissions

Copyright information

© 2013 Springer-Verlag Berlin Heidelberg

About this paper

Cite this paper

Diaz-Pace, J.A., Nicoletti, M., Schiaffino, S., Villavicencio, C., Sanchez, L.E. (2013). A Stakeholder-Centric Optimization Strategy for Architectural Documentation. In: Cuzzocrea, A., Maabout, S. (eds) Model and Data Engineering. MEDI 2013. Lecture Notes in Computer Science, vol 8216. Springer, Berlin, Heidelberg. https://doi.org/10.1007/978-3-642-41366-7_9

Download citation

  • DOI: https://doi.org/10.1007/978-3-642-41366-7_9

  • Publisher Name: Springer, Berlin, Heidelberg

  • Print ISBN: 978-3-642-41365-0

  • Online ISBN: 978-3-642-41366-7

  • eBook Packages: Computer ScienceComputer Science (R0)

Publish with us

Policies and ethics