Abstract
Architecture documentation is a crucial activity in any software development project. In practice, architecture documenters face two problems: how to generate relevant documentation contents for the main stakeholders, and how to avoid documenting too much about the architecture. We propose a personalization approach based on stakeholders’ interests to tackle these problems. The expected contribution is to facilitate the documenter’s tasks, while making the resulting documentation useful to the stakeholders. We specifically describe a user profiling tool that builds stakeholders’ profiles, which serve to link the stakeholders to sections of the architectural documents. These links help the documenter to prioritize sections that are potentially relevant to those stakeholders. The tool has been implemented as a semi-automated pipeline based on text mining techniques. The results, although preliminary, show that our proposal is helpful for a stakeholder-centric architecture documentation process.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Preview
Unable to display preview. Download preview PDF.
References
Bachmann, F., Merson, P.: Experience using the web-based tool wiki for architecture documentation. Technical Report TN-041, CMU-SEI (2005)
Clements, P., et al.: A practical method for documenting software architectures. In: ICSE (2003)
Clements, P., et al.: Documenting Software Architectures: Views and Beyond, 2nd edn. Addison-Wesley Professional (2010)
Farenhorst, R., et al.: A just-in-time architectural knowledge sharing portal. In: Proc. of WICSA 2008, pp. 125–134. IEEE, Washington DC (2008)
Goossen, F., et al.: News personalization using the CF-IDF semantic recommender. In: Proc. of WIMS 2011, pp. 10:1–10:12. ACM, New York (2011)
IEEE Std 1471-2000: Recommended practice for architectural description of software-intensive systems (2000)
Jansen, A., et al.: Enriching software architecture documentation. Journal of Systems and Software 82(8), 1232–1248 (2009)
Koning, H., Vliet, H.: Real-life IT architecture design reports and their relation to IEEE Std 1471 stakeholders and concerns. Automated Software Eng. 13, 201–223 (2006)
Schiaffino, S., Amandi, A.: Intelligent User Profiling. In: Artificial Intelligence, pp. 193–216. Springer, Heidelberg (2009)
Su, M.T., Hosking, J., Grundy, J.: Capturing architecture documentation navigation trails for content chunking and sharing. In: The 9th IEEE/IFIP (WICSA), pp. 256–259 (2011)
Su, M.T.: Capturing exploration to improve software architecture documentation. In: Proceedings of ECSA 2010, pp. 17–21. ACM, New York (2010)
Tang, A., et al.: A comparative study of architecture knowledge management tools. Journal of Systems and Software 83, 352–370 (2010)
Author information
Authors and Affiliations
Editor information
Editors and Affiliations
Rights and permissions
Copyright information
© 2012 Springer-Verlag Berlin Heidelberg
About this paper
Cite this paper
Nicoletti, M., Diaz-Pace, J.A., Schiaffino, S. (2012). Towards Software Architecture Documents Matching Stakeholders’ Interests. In: Cipolla-Ficarra, F., Veltman, K., Verber, D., Cipolla-Ficarra, M., Kammüller, F. (eds) Advances in New Technologies, Interactive Interfaces and Communicability. ADNTIIC 2011. Lecture Notes in Computer Science, vol 7547. Springer, Berlin, Heidelberg. https://doi.org/10.1007/978-3-642-34010-9_17
Download citation
DOI: https://doi.org/10.1007/978-3-642-34010-9_17
Publisher Name: Springer, Berlin, Heidelberg
Print ISBN: 978-3-642-34009-3
Online ISBN: 978-3-642-34010-9
eBook Packages: Computer ScienceComputer Science (R0)