How Do Open Source Communities Document Software Architecture: An Exploratory Survey
The DOI matches its Crossref record; 11 of the 11 references it cites were found in a registry or an index.
Abstract
Software architecture (SA) documentation provides a blueprint of a software-intensive system for the communication between stakeholders about the high-level design of the system. In open source software (OSS) development, a lack of SA documentation may hinder the use and further development of OSS, but how much "architecture" documentation is enough and appropriate is largely dependent on the contextual factors of development. In order to understand the state of the practice of SA documentation in OSS projects, we conducted a documentation-based survey to explore how SA is documented in OSS projects. Out of 2,000 OSS projects from four major OSS sources, we found that 108 projects have some SA documentation, which shows that the SA documentation is scarce in OSS development. We analyzed these 108 projects to understand what SA information has been documented and how they have been described. We have found that frequently-documented architectural information is model, system, and mission, natural language is the most frequently-used architectural language for specifying architectural information in OSS SA documents. The results also show that the likelihood that an OSS project will document SA is increased when more developers are involved in the project, and industry and research OSS projects are more likely to create SA documents than freelance projects.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cites
Experimentation in Software Engineering
Wohlin, C., Runeson, P., Höst, M., Ohlsson, M. C., Regnell, B., & Wesslén, A. (2012) · doi:10.1007/978-3-642-29044-2 · Cited by 4,460
Guidelines for conducting and reporting case study research in software engineering
Runeson, P., & Höst, M. (2009) · Empirical Software Engineering · doi:10.1007/s10664-008-9102-8 · Cited by 3,862 · cited 1×
“This survey is an exploratory survey to explore facts, seek new insights, and to generate ideas and hypotheses for new research [28][29].”
BackgroundEmpirical studies of agile software development: A systematic review
Dybå, T., & Dingsøyr, T. (2008) · Information and Software Technology · doi:10.1016/j.infsof.2008.01.006 · Cited by 2,668
Some Simple Economics of Open Source
Lerner, J., & Tirole, J. (2002) · The Journal of Industrial Economics · doi:10.1111/1467-6451.00174 · Cited by 2,355
A classification and comparison framework for software architecture description languages
Medvidovic, N., & Taylor, R. N. (2000) · IEEE Transactions on Software Engineering · doi:10.1109/32.825767 · Cited by 1,987 · cited 1×
“ADL: Architecture description languages (ADL) provide formally-specified modeling notations and constrains to describe architectural information, for example, using C2 to formally specify components and connectors [38].”
BackgroundSurvey research methodology in management information systems: an assessment
Pinsonneault, A., & Kraemer, K. (1993) · Journal of Management Information Systems · doi:10.1080/07421222.1993.11518001 · Cited by 1,288 · cited 1×
“This survey is an exploratory survey to explore facts, seek new insights, and to generate ideas and hypotheses for new research [28][29].”
BackgroundSelecting Empirical Methods for Software Engineering Research
Easterbrook, S., Singer, J., Storey, M.-A., & Damian, D. (2008) · Guide to Advanced Empirical Software Engineering · doi:10.1007/978-1-84800-044-5_11 · Cited by 1,167 · cited 2×
“For 1 SAD is singular as well as plural based on the context in which the term is used.”
BackgroundControlling software architecture erosion: A survey
de Silva, L., & Balasubramaniam, D. (2012) · Journal of Systems and Software · doi:10.1016/j.jss.2011.07.036 · Cited by 184
Knowledge-based approaches in software documentation: A systematic literature review
Ding, W., Liang, P., Tang, A., & van Vliet, H. (2014) · Information and Software Technology · doi:10.1016/j.infsof.2014.01.008 · Cited by 107
Self-citationApplication of knowledge-based approaches in software architecture: A systematic mapping study
Li, Z., Liang, P., & Avgeriou, P. (2013) · Information and Software Technology · doi:10.1016/j.infsof.2012.11.005 · Cited by 74 · cited 1×
“, using various knowledge-based approaches [54]) with these sources, and how these sources can be collected to enrich OSS SA documentation.”
BackgroundSelf-citation
Cited by
10 years of software architecture knowledge management: Practice and future
Capilla, R., Jansen, A., Tang, A., Avgeriou, P., & Babar, M. A. (2016) · Journal of Systems and Software · doi:10.1016/j.jss.2015.08.054 · Cited by 160
Self-citationKazman, R., Goldenson, D., Monarch, I., Nichols, W., & Valetto, G. (2016) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2015.2465387 · Cited by 31
Are code smell detection tools suitable for detecting architecture degradation?
Lenhard, J., Hassan, M. M., Blom, M., & Herold, S. (2017) · Proceedings of the 11th European Conference on Software Architecture: Companion Proceedings · doi:10.1145/3129790.3129808 · Cited by 10
“Unfortunately, this straight-forward approach faces obstacles in practice, since documentation or models of a system’s intended architecture are often missing [7].”
BackgroundMuszynski, M., Lugtigheid, S., Castor, F., & Brinkkemper, S. (2022) · 2022 IEEE 19th International Conference on Software Architecture (ICSA) · doi:10.1109/icsa53651.2022.00013 · Cited by 10
Metadata
- Authors
- Ding, W., Liang, P., Tang, A., Van Vliet, H., & Shahin, M.
- Venue
- 2014 19th International Conference on Engineering of Complex Computer Systems
- Publisher
- IEEE
- Published
- 2014-08
- Pages
- 136-145
- OpenAlex
- W2009467197
- Cited by
- 54
- References
- 11
- FWCI
- 3.36
- Type
- conference paper
- Language
- en
- Open access
- closed
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.