A study of documentation for software architecture
Documentation is an important mechanism for disseminating software architecture knowledge. Software project teams can employ vastly different formats for documenting software architecture, from unstructured narratives to standardized documents. We explored to what extent this documentation format ma...
Saved in:
| Published in | Empirical software engineering : an international journal Vol. 28; no. 5; p. 122 |
|---|---|
| Main Authors | , |
| Format | Journal Article |
| Language | English |
| Published |
New York
Springer US
01.09.2023
Springer Nature B.V |
| Subjects | |
| Online Access | Get full text |
Cover
Loading…
| Abstract | Documentation is an important mechanism for disseminating software architecture knowledge. Software project teams can employ vastly different formats for documenting software architecture, from unstructured narratives to standardized documents. We explored to what extent this documentation format may matter to newcomers joining a software project and attempting to understand its architecture. We conducted a controlled questionnaire-based study wherein we asked 65 participants to answer software architecture understanding questions using one of two randomly-assigned documentation formats: narrative essays, and structured documents. We analyzed the factors associated with answer quality using a Bayesian ordered categorical regression and observed no significant association between the format of architecture documentation and performance on architecture understanding tasks. Instead, prior exposure to the source code of the system was the dominant factor associated with answer quality. We also observed that answers to questions that require applying and creating activities were statistically significantly associated with the use of the system’s source code to answer the question, whereas the document format or level of familiarity with the system were not. Subjective sentiment about the documentation format was comparable: Although more participants agreed that the structured document was easier to navigate and use for writing code, this relation was not statistically significant. We conclude that, in the limited experimental context studied, our results contradict the hypothesis that the format of architectural documentation matters. We surface two more important factors related to effective use of software architecture documentation: prior familiarity with the source code, and the type of architectural information sought. |
|---|---|
| AbstractList | Documentation is an important mechanism for disseminating software architecture knowledge. Software project teams can employ vastly different formats for documenting software architecture, from unstructured narratives to standardized documents. We explored to what extent this documentation format may matter to newcomers joining a software project and attempting to understand its architecture. We conducted a controlled questionnaire-based study wherein we asked 65 participants to answer software architecture understanding questions using one of two randomly-assigned documentation formats: narrative essays, and structured documents. We analyzed the factors associated with answer quality using a Bayesian ordered categorical regression and observed no significant association between the format of architecture documentation and performance on architecture understanding tasks. Instead, prior exposure to the source code of the system was the dominant factor associated with answer quality. We also observed that answers to questions that require applying and creating activities were statistically significantly associated with the use of the system’s source code to answer the question, whereas the document format or level of familiarity with the system were not. Subjective sentiment about the documentation format was comparable: Although more participants agreed that the structured document was easier to navigate and use for writing code, this relation was not statistically significant. We conclude that, in the limited experimental context studied, our results contradict the hypothesis that the format of architectural documentation matters. We surface two more important factors related to effective use of software architecture documentation: prior familiarity with the source code, and the type of architectural information sought. |
| ArticleNumber | 122 |
| Author | Robillard, Martin P. Ernst, Neil A. |
| Author_xml | – sequence: 1 givenname: Neil A. orcidid: 0000-0001-5992-2366 surname: Ernst fullname: Ernst, Neil A. email: nernst@uvic.ca organization: Department of Computer Science, University of Victoria – sequence: 2 givenname: Martin P. surname: Robillard fullname: Robillard, Martin P. organization: School of Computer Science, McGill University |
| BookMark | eNp9kE1LAzEQhoMo2Fb_gKcFz9F8fxxL8QsKXvQckk2iW9pNTbJI_72rKwgeepo5zDPvzDMHp33qAwBXGN1ghORtwUgIBhGhECPKJCQnYIa5pFAKLE7HnioCKeHiHMxL2SCEtGR8BsiyKXXwhybFxqd22IW-2tqlvokpNyXF-mlzaGxu37sa2jrkcAHOot2WcPlbF-D1_u5l9QjXzw9Pq-UathTrCqNy0WEtucPYcxel9Dj46ILSiumgBeKOc-K9cyEG6xRmKFrFOFMIUa_pAlxPe_c5fQyhVLNJQ-7HSEOU4JhKIsk4RaapNqdScohmn7udzQeDkfl2YyY3ZnRjftyYb0j9g9puertm222Po3RCy5jTv4X8d9UR6gvHyXqA |
| CitedBy_id | crossref_primary_10_1145_3702976 |
| Cites_doi | 10.1016/j.jss.2015.08.054 10.1007/s11222-016-9696-4 10.1016/j.jss.2020.110699 10.1145/3017680.3017737 10.1109/WICSA.2014.28 10.1109/ICSA.2017.15 10.1177/2515245918823199 10.1007/s13740-015-0053-0 10.1016/j.jss.2009.04.052 10.1145/1806799.1806842 10.1109/ICSE.2015.54 10.1177/2515245917745629 10.1109/WICSA-ECSA.212.20 10.1109/MS.2014.107 10.1145/3490953 10.1109/ESEM.2011.25 10.1007/978-3-540-77619-2_14 10.1145/2786805.2786854 10.1109/TSE.2020.3048991 10.1002/smr.1921 10.1016/j.infsof.2014.11.001 10.1016/j.infsof.2014.01.008 10.1007/978-3-540-77619-2_12 10.1109/52.469759 10.1145/2884781.2884792 10.1109/MSR.2015.45 10.1016/j.scico.2015.10.014 10.1201/9780429029608 10.1007/s10664-020-09835-6 10.1109/ICGSE.2017.11 10.1145/2038476.2038517 10.1109/MS.2018.110162131 |
| ContentType | Journal Article |
| Copyright | The Author(s), under exclusive licence to Springer Science+Business Media, LLC, part of Springer Nature 2023. Springer Nature or its licensor (e.g. a society or other partner) holds exclusive rights to this article under a publishing agreement with the author(s) or other rightsholder(s); author self-archiving of the accepted manuscript version of this article is solely governed by the terms of such publishing agreement and applicable law. |
| Copyright_xml | – notice: The Author(s), under exclusive licence to Springer Science+Business Media, LLC, part of Springer Nature 2023. Springer Nature or its licensor (e.g. a society or other partner) holds exclusive rights to this article under a publishing agreement with the author(s) or other rightsholder(s); author self-archiving of the accepted manuscript version of this article is solely governed by the terms of such publishing agreement and applicable law. |
| DBID | AAYXX CITATION 7SC 8FD 8FE 8FG ABJCF AFKRA ARAPS BENPR BGLVJ CCPQU DWQXO HCIFZ JQ2 L6V L7M L~C L~D M7S P5Z P62 PHGZM PHGZT PKEHL PQEST PQGLB PQQKQ PQUKI PTHSS S0W |
| DOI | 10.1007/s10664-023-10347-2 |
| DatabaseName | CrossRef Computer and Information Systems Abstracts Technology Research Database ProQuest SciTech Collection ProQuest Technology Collection Materials Science & Engineering Collection ProQuest Central UK/Ireland Advanced Technologies & Aerospace Collection ProQuest Central Technology Collection ProQuest One Community College ProQuest Central Korea SciTech Premium Collection ProQuest Computer Science Collection ProQuest Engineering Collection Advanced Technologies Database with Aerospace Computer and Information Systems Abstracts Academic Computer and Information Systems Abstracts Professional Engineering Database Advanced Technologies & Aerospace Database ProQuest Advanced Technologies & Aerospace Collection ProQuest Central Premium ProQuest One Academic ProQuest One Academic Middle East (New) ProQuest One Academic Eastern Edition (DO NOT USE) ProQuest One Applied & Life Sciences ProQuest One Academic ProQuest One Academic UKI Edition Engineering Collection DELNET Engineering & Technology Collection |
| DatabaseTitle | CrossRef Technology Collection Technology Research Database Computer and Information Systems Abstracts – Academic ProQuest One Academic Middle East (New) ProQuest Advanced Technologies & Aerospace Collection ProQuest Computer Science Collection Computer and Information Systems Abstracts SciTech Premium Collection ProQuest One Community College ProQuest Central ProQuest One Applied & Life Sciences ProQuest Engineering Collection ProQuest Central Korea ProQuest Central (New) Advanced Technologies Database with Aerospace Engineering Collection Advanced Technologies & Aerospace Collection Engineering Database ProQuest One Academic Eastern Edition ProQuest Technology Collection ProQuest SciTech Collection Computer and Information Systems Abstracts Professional Advanced Technologies & Aerospace Database ProQuest One Academic UKI Edition ProQuest DELNET Engineering and Technology Collection Materials Science & Engineering Collection ProQuest One Academic ProQuest One Academic (New) |
| DatabaseTitleList | Technology Collection |
| Database_xml | – sequence: 1 dbid: 8FG name: ProQuest Technology Collection url: https://search.proquest.com/technologycollection1 sourceTypes: Aggregation Database |
| DeliveryMethod | fulltext_linktorsrc |
| Discipline | Computer Science Architecture |
| EISSN | 1573-7616 |
| ExternalDocumentID | 10_1007_s10664_023_10347_2 |
| GrantInformation_xml | – fundername: Natural Sciences and Engineering Research Council of Canada funderid: http://dx.doi.org/10.13039/501100000038 |
| GroupedDBID | -4Z -59 -5G -BR -EM -Y2 -~C .86 .DC .VR 06D 0R~ 0VY 199 1N0 1SB 2.D 203 28- 29G 2J2 2JN 2JY 2KG 2LR 2P1 2VQ 2~H 30V 4.4 406 408 409 40D 40E 5GY 5QI 5VS 67Z 6NX 78A 8FE 8FG 8TC 8UJ 95- 95. 95~ 96X AABHQ AACDK AAHNG AAIAL AAJBT AAJKR AANZL AAOBN AARHV AARTL AASML AATNV AATVU AAUYE AAWCG AAYIU AAYOK AAYQN AAYTO AAYZH ABAKF ABBBX ABBXA ABDZT ABECU ABFTD ABFTV ABHLI ABHQN ABJCF ABJNI ABJOX ABKCH ABKTR ABMNI ABMQK ABNWP ABQBU ABQSL ABSXP ABTEG ABTHY ABTKH ABTMW ABULA ABWNU ABXPI ACAOD ACBXY ACDTI ACGFS ACHSB ACHXU ACIWK ACKNC ACMDZ ACMLO ACOKC ACOMO ACPIV ACSNA ACZOJ ADHHG ADHIR ADIMF ADINQ ADKNI ADKPE ADRFC ADTPH ADURQ ADYFF ADZKW AEBTG AEFIE AEFQL AEGAL AEGNC AEJHL AEJRE AEKMD AEMSY AENEX AEOHA AEPYU AESKC AETLH AEVLU AEXYK AFBBN AFEXP AFGCZ AFKRA AFLOW AFQWF AFWTZ AFZKB AGAYW AGDGC AGGDS AGJBK AGMZJ AGQEE AGQMX AGRTI AGWIL AGWZB AGYKE AHAVH AHBYD AHKAY AHSBF AHYZX AIAKS AIGIU AIIXL AILAN AITGF AJBLW AJRNO AJZVZ ALMA_UNASSIGNED_HOLDINGS ALWAN AMKLP AMXSW AMYLF AMYQR AOCGG ARAPS ARMRJ ASPBG AVWKF AXYYD AYJHY AZFZN B-. BA0 BBWZM BDATZ BENPR BGLVJ BGNMA BSONS CAG CCPQU COF CS3 CSCUP DDRTE DL5 DNIVK DPUIP DU5 EBLON EBS EIOEI EJD ESBYG FEDTE FERAY FFXSO FIGPU FINBP FNLPD FRRFC FSGXE FWDCC GGCAI GGRSB GJIRD GNWQR GQ6 GQ7 GQ8 GXS H13 HCIFZ HF~ HG5 HG6 HMJXF HQYDN HRMNR HVGLF HZ~ I09 IHE IJ- IKXTQ ITM IWAJR IXC IZIGR IZQ I~X I~Z J-C J0Z JBSCW JCJTX JZLTJ KDC KOV KOW L6V LAK LLZTM M4Y M7S MA- N2Q NB0 NDZJH NPVJJ NQJWS NU0 O9- O93 O9G O9I O9J OAM P19 P62 P9O PF0 PT4 PT5 PTHSS Q2X QOK QOS R4E R89 R9I RHV RNI RNS ROL RPX RSV RZC RZE RZK S0W S16 S1Z S26 S27 S28 S3B SAP SCJ SCLPG SCO SDH SDM SHX SISQX SJYHP SNE SNPRN SNX SOHCF SOJ SPISZ SRMVM SSLCW STPWE SZN T13 T16 TSG TSK TSV TUC U2A UG4 UOJIU UTJUX UZXMN VC2 VFIZW W23 W48 WK8 YLTOR Z45 Z7R Z7S Z7V Z7X Z7Z Z81 Z83 Z86 Z88 Z8M Z8N Z8P Z8R Z8T Z8U Z8W Z92 ZMTXR ~EX AAPKM AAYXX ABBRH ABDBE ABFSG ACSTC ADHKG AEZWR AFDZB AFHIU AFOHR AGQPQ AHPBZ AHWEU AIXLP ATHPR AYFIA CITATION PHGZM PHGZT 7SC 8FD ABRTQ DWQXO JQ2 L7M L~C L~D PKEHL PQEST PQGLB PQQKQ PQUKI |
| ID | FETCH-LOGICAL-c319t-f8bfb1975b11d5bf77d1edfbe89849e9605b552ddbbefeab8140fa84548003d93 |
| IEDL.DBID | BENPR |
| ISSN | 1382-3256 |
| IngestDate | Fri Jul 25 18:50:52 EDT 2025 Tue Jul 01 03:32:22 EDT 2025 Thu Apr 24 23:09:58 EDT 2025 Fri Feb 21 02:41:26 EST 2025 |
| IsPeerReviewed | true |
| IsScholarly | true |
| Issue | 5 |
| Keywords | Program comprehension Developer onboarding Software architecture Software documentation Documentation style |
| Language | English |
| LinkModel | DirectLink |
| MergedId | FETCHMERGED-LOGICAL-c319t-f8bfb1975b11d5bf77d1edfbe89849e9605b552ddbbefeab8140fa84548003d93 |
| Notes | ObjectType-Article-1 SourceType-Scholarly Journals-1 ObjectType-Feature-2 content type line 14 |
| ORCID | 0000-0001-5992-2366 |
| PQID | 2865137272 |
| PQPubID | 326341 |
| ParticipantIDs | proquest_journals_2865137272 crossref_primary_10_1007_s10664_023_10347_2 crossref_citationtrail_10_1007_s10664_023_10347_2 springer_journals_10_1007_s10664_023_10347_2 |
| ProviderPackageCode | CITATION AAYXX |
| PublicationCentury | 2000 |
| PublicationDate | 2023-09-01 |
| PublicationDateYYYYMMDD | 2023-09-01 |
| PublicationDate_xml | – month: 09 year: 2023 text: 2023-09-01 day: 01 |
| PublicationDecade | 2020 |
| PublicationPlace | New York |
| PublicationPlace_xml | – name: New York – name: Dordrecht |
| PublicationSubtitle | An International Journal |
| PublicationTitle | Empirical software engineering : an international journal |
| PublicationTitleAbbrev | Empir Software Eng |
| PublicationYear | 2023 |
| Publisher | Springer US Springer Nature B.V |
| Publisher_xml | – name: Springer US – name: Springer Nature B.V |
| References | SteinmacherITreudeCGerosaMALet me in: Guidelines for the successful onboarding of newcomers to open source projectsIEEE Software2019364414910.1109/MS.2018.110162131 BürknerPCVuorreMOrdinal regression models in psychology: A tutorialAdv Methods Practices Psychol Sci2019217710110.1177/2515245918823199 Fairbanks G (2010) Just Enough Software Architecture: A Risk-Driven Approach. Marshall & Brainerd Schoonewille HH, Heijstek W, Chaudron MR, Kühne T (2011) A cognitive perspective on developer comprehension of software design documentation. In Proceedings of the 29th ACM International Conference on Design of Communication, pp 211–218 CapillaRJansenATangAAvgeriouPBabarMA10 years of software architecture knowledge management: Practice and futureJ Syst Softw201611619120510.1016/j.jss.2015.08.054 Dagenais B, Ossher H, Bellamy RKE, Robillard MP, de Vries JP (2010) Moving into a new software project landscape. In Proceedings of the 32nd ACM/IEEE International Conference on Software Engineering, p 275–284 BrittoRSmiteDDammLOBörstlerJEvaluating and strategizing the onboarding of software developers in large-scale globally distributed projectsJ Syst Software202016910.1016/j.jss.2020.110699 SteinmacherIGraciotto SilvaMAGerosaMARedmilesDFA systematic literature review on the barriers faced by newcomers to open source software projectsInf Softw Technol201559678510.1016/j.infsof.2014.11.001 Brown A, Wilson G (2012) The Architecture of Open Source Applications. Lulu Inc. http://aosabook.org/en/index.html Gelman A, Vehtari A, Simpson D, Margossian CC, Carpenter B, Yao Y, Kennedy L, Gabry J, Bürkner PC, Modrák M (2020) Bayesian workflow. https://arxiv.org/abs/2011.01808 Spinellis D, Gousios G (eds) (2009) Beautiful Architecture: Leading Thinkers Reveal the Hidden Beauty in Software Design. O’Reilly Media FuriaCATorkarRFeldtRApplying bayesian analysis guidelines to empirical software engineering data: The case of programming languages and code qualityACM Trans Softw Eng Methodol202231313810.1145/3490953 Robillard MP, Medvidovíc N (2016) Disseminating architectural knowledge on open-source projects: A case study of the book “architecture of open-source applications”. In Proceedings of the 38th ACM/IEEE International Conference on Software Engineering Van Deursen A, Aniche M, Aué J, Slag R, De Jong M, Nederlof A, Bouwers E (2017) A collaborative approach to teaching software architecture. In Proceedings of the SIGCSE Technical Symposium on Computer Science Education, pp 591–596 Tang A, Razavian M, Paech B, Hesse T (2017) Human aspects in software architecture decision making: A literature review. In Proceedings of the IEEE International Conference on Software Architecture, pp 107–116 Heijstek W, Kühne T, Chaudron M (2011) Experimental analysis of textual and graphical representations for software architecture design. In Proceedings of the International Symposium on Empirical Software Engineering and Measurement, pp 167–176 Labuschagne A, Holmes R (2015) Do onboarding programs work? In Proceedings of the IEEE/ACM 12th Working Conference on Mining Software Repositories, pp 381–385 RohrerJMThinking clearly about correlations and causation: Graphical causal models for observational dataAdv Methods Pract Psychol Sci2018112742375580110.1177/2515245917745629 FagerholmFSanchez GuineaABorensteinJMünchJOnboarding in open source projectsIEEE Softw2014316546110.1109/MS.2014.107 Rozanski N, Woods E (2012) Software Systems Architecture: Working with Stakeholders Using Viewpoints and Perspectives, 2nd edn. Pearson Education Casalnuovo C, Vasilescu B, Devanbu P, Filkov V (2015) Developer onboarding in GitHub: the role of prior social links and language experience. In Proceedings of the 10th Joint Meeting on Foundations of Software Engineering, pp 817–828 ClementsPBachmannFBassLGarlanDIversJLittleRMersonPNordRStaffordJDocumenting Software Architectures: Views and Beyond20102Addison Wesley DingWLiangPTangAvan VlietHKnowledge-based approaches in software documentation: A systematic literature reviewInf Softw Tech201456654556710.1016/j.infsof.2014.01.008 BrittoRCruzesDSSmiteDSablisAOnboarding software developers and teams in three globally distributed legacy projects: A multi-case studyJ Softw Evol Process201830410.1002/smr.1921 Lin B, Robles G, Serebrenik A (2017) Developer turnover in global, industrial open source projects: Insights from applying survival analysis. In Proceedings of the 12th IEEE International Conference on Global Software Engineering, pp 66–75 Clerc V, Lago P, van Vliet H (2007) The architect’s mindset. In Proceedings of the International Conference on the Quality of Software Architectures, pp 231–249 de Graaf KA, Tang A, Liang P, van Vliet H (2012) Ontology-based software architecture documentation. In: Proceedings of the Joint Working Conference on Software Architecture and European Conference on Software Architecture, pp 121–130 JansenAAvgeriouPvan der VenJSEnriching software architecture documentationJ Syst Softw20098281232124810.1016/j.jss.2009.04.052 TorkarRFuriaCAFeldtRde Oliveira NetoFGGrenLLenbergPErnstNAA method to assess and argue for practical significance in software engineeringIEEE Trans Software Eng20214862053206510.1109/TSE.2020.3048991 McElreathRStatistical Rethinking20202Chapman and Hall10.1201/9780429029608 BloomBSA taxonomy for learning, teaching, and assessing : A revision of Bloom’s taxonomy of educational objectives2001abridgedLongman de GraafKALiangPTangAvan VlietHHow organisation of architecture documentation affects architectural knowledge retrievalSci Comput Prog2016121759910.1016/j.scico.2015.10.014 de Boer RC, Farenhorst R, Lago P, van Vliet H, Clerc V, Jansen A (2007) Architectural knowledge: Getting to the core. In Proceedings of the International Conference on the Quality of Software Architectures, pp 197–214 KruchtenPBThe 4+1 view model of architectureIEEE Software1995126425010.1109/52.469759 Galster M, Babar MA (2014) Empirical study of architectural knowledge management practices. In Proceedings of the Working IEEE/IFIP Conference on Software Architecture, pp 239–242 VehtariAGelmanAGabryJPractical bayesian model evaluation using leave-one-out cross-validation and WAICStat Comput201627514131432364710510.1007/s11222-016-9696-41505.62408 Díaz-PaceJAVillavicencioCSchiaffinoSNicolettiMVázquezHProducing just enough documentation: An optimization approach applied to the software architecture domainJ Data Semantics201651375310.1007/s13740-015-0053-0 Waterman M, Noble J, Allan G (2015) How much up-front? A grounded theory of agile architecture. In Proceedings of the IEEE/ACM International Conference on Software Engineering, pp 347–357 JolakRSavary-LeblancMDaliborMWortmannAHebigRVincurJPolasekILe PallecXGérardSChaudronMRSoftware engineering whispers: The effect of textual vs. graphical software design descriptions on software design communicationEmpir Softw Eng20202564427447110.1007/s10664-020-09835-6 10347_CR5 10347_CR25 10347_CR26 10347_CR2 10347_CR28 I Steinmacher (10347_CR34) 2019; 36 10347_CR40 10347_CR21 R McElreath (10347_CR27) 2020 JA Díaz-Pace (10347_CR12) 2016; 5 W Ding (10347_CR13) 2014; 56 R Torkar (10347_CR36) 2021; 48 A Vehtari (10347_CR38) 2016; 27 R Britto (10347_CR4) 2020; 169 CA Furia (10347_CR16) 2022; 31 KA de Graaf (10347_CR20) 2016; 121 R Jolak (10347_CR23) 2020; 25 R Britto (10347_CR3) 2018; 30 PB Kruchten (10347_CR24) 1995; 12 I Steinmacher (10347_CR33) 2015; 59 10347_CR35 10347_CR15 10347_CR37 10347_CR17 JM Rohrer (10347_CR29) 2018; 1 10347_CR18 10347_CR19 10347_CR30 PC Bürkner (10347_CR6) 2019; 2 10347_CR31 10347_CR10 10347_CR32 10347_CR11 F Fagerholm (10347_CR14) 2014; 31 A Jansen (10347_CR22) 2009; 82 BS Bloom (10347_CR1) 2001 R Capilla (10347_CR7) 2016; 116 10347_CR8 P Clements (10347_CR9) 2010 A Vehtari (10347_CR39) 2016; 27 |
| References_xml | – reference: BrittoRSmiteDDammLOBörstlerJEvaluating and strategizing the onboarding of software developers in large-scale globally distributed projectsJ Syst Software202016910.1016/j.jss.2020.110699 – reference: TorkarRFuriaCAFeldtRde Oliveira NetoFGGrenLLenbergPErnstNAA method to assess and argue for practical significance in software engineeringIEEE Trans Software Eng20214862053206510.1109/TSE.2020.3048991 – reference: VehtariAGelmanAGabryJPractical bayesian model evaluation using leave-one-out cross-validation and WAICStat Comput201627514131432364710510.1007/s11222-016-9696-41505.62408 – reference: DingWLiangPTangAvan VlietHKnowledge-based approaches in software documentation: A systematic literature reviewInf Softw Tech201456654556710.1016/j.infsof.2014.01.008 – reference: JolakRSavary-LeblancMDaliborMWortmannAHebigRVincurJPolasekILe PallecXGérardSChaudronMRSoftware engineering whispers: The effect of textual vs. graphical software design descriptions on software design communicationEmpir Softw Eng20202564427447110.1007/s10664-020-09835-6 – reference: RohrerJMThinking clearly about correlations and causation: Graphical causal models for observational dataAdv Methods Pract Psychol Sci2018112742375580110.1177/2515245917745629 – reference: de Boer RC, Farenhorst R, Lago P, van Vliet H, Clerc V, Jansen A (2007) Architectural knowledge: Getting to the core. In Proceedings of the International Conference on the Quality of Software Architectures, pp 197–214 – reference: Casalnuovo C, Vasilescu B, Devanbu P, Filkov V (2015) Developer onboarding in GitHub: the role of prior social links and language experience. In Proceedings of the 10th Joint Meeting on Foundations of Software Engineering, pp 817–828 – reference: Lin B, Robles G, Serebrenik A (2017) Developer turnover in global, industrial open source projects: Insights from applying survival analysis. In Proceedings of the 12th IEEE International Conference on Global Software Engineering, pp 66–75 – reference: Rozanski N, Woods E (2012) Software Systems Architecture: Working with Stakeholders Using Viewpoints and Perspectives, 2nd edn. Pearson Education – reference: Waterman M, Noble J, Allan G (2015) How much up-front? A grounded theory of agile architecture. In Proceedings of the IEEE/ACM International Conference on Software Engineering, pp 347–357 – reference: Galster M, Babar MA (2014) Empirical study of architectural knowledge management practices. In Proceedings of the Working IEEE/IFIP Conference on Software Architecture, pp 239–242 – reference: Labuschagne A, Holmes R (2015) Do onboarding programs work? In Proceedings of the IEEE/ACM 12th Working Conference on Mining Software Repositories, pp 381–385 – reference: SteinmacherIGraciotto SilvaMAGerosaMARedmilesDFA systematic literature review on the barriers faced by newcomers to open source software projectsInf Softw Technol201559678510.1016/j.infsof.2014.11.001 – reference: ClementsPBachmannFBassLGarlanDIversJLittleRMersonPNordRStaffordJDocumenting Software Architectures: Views and Beyond20102Addison Wesley – reference: Tang A, Razavian M, Paech B, Hesse T (2017) Human aspects in software architecture decision making: A literature review. In Proceedings of the IEEE International Conference on Software Architecture, pp 107–116 – reference: Heijstek W, Kühne T, Chaudron M (2011) Experimental analysis of textual and graphical representations for software architecture design. In Proceedings of the International Symposium on Empirical Software Engineering and Measurement, pp 167–176 – reference: BrittoRCruzesDSSmiteDSablisAOnboarding software developers and teams in three globally distributed legacy projects: A multi-case studyJ Softw Evol Process201830410.1002/smr.1921 – reference: CapillaRJansenATangAAvgeriouPBabarMA10 years of software architecture knowledge management: Practice and futureJ Syst Softw201611619120510.1016/j.jss.2015.08.054 – reference: Schoonewille HH, Heijstek W, Chaudron MR, Kühne T (2011) A cognitive perspective on developer comprehension of software design documentation. In Proceedings of the 29th ACM International Conference on Design of Communication, pp 211–218 – reference: Robillard MP, Medvidovíc N (2016) Disseminating architectural knowledge on open-source projects: A case study of the book “architecture of open-source applications”. In Proceedings of the 38th ACM/IEEE International Conference on Software Engineering – reference: BloomBSA taxonomy for learning, teaching, and assessing : A revision of Bloom’s taxonomy of educational objectives2001abridgedLongman – reference: Clerc V, Lago P, van Vliet H (2007) The architect’s mindset. In Proceedings of the International Conference on the Quality of Software Architectures, pp 231–249 – reference: de Graaf KA, Tang A, Liang P, van Vliet H (2012) Ontology-based software architecture documentation. In: Proceedings of the Joint Working Conference on Software Architecture and European Conference on Software Architecture, pp 121–130 – reference: McElreathRStatistical Rethinking20202Chapman and Hall10.1201/9780429029608 – reference: SteinmacherITreudeCGerosaMALet me in: Guidelines for the successful onboarding of newcomers to open source projectsIEEE Software2019364414910.1109/MS.2018.110162131 – reference: Dagenais B, Ossher H, Bellamy RKE, Robillard MP, de Vries JP (2010) Moving into a new software project landscape. In Proceedings of the 32nd ACM/IEEE International Conference on Software Engineering, p 275–284 – reference: FagerholmFSanchez GuineaABorensteinJMünchJOnboarding in open source projectsIEEE Softw2014316546110.1109/MS.2014.107 – reference: FuriaCATorkarRFeldtRApplying bayesian analysis guidelines to empirical software engineering data: The case of programming languages and code qualityACM Trans Softw Eng Methodol202231313810.1145/3490953 – reference: Van Deursen A, Aniche M, Aué J, Slag R, De Jong M, Nederlof A, Bouwers E (2017) A collaborative approach to teaching software architecture. In Proceedings of the SIGCSE Technical Symposium on Computer Science Education, pp 591–596 – reference: Fairbanks G (2010) Just Enough Software Architecture: A Risk-Driven Approach. Marshall & Brainerd – reference: Spinellis D, Gousios G (eds) (2009) Beautiful Architecture: Leading Thinkers Reveal the Hidden Beauty in Software Design. O’Reilly Media – reference: KruchtenPBThe 4+1 view model of architectureIEEE Software1995126425010.1109/52.469759 – reference: de GraafKALiangPTangAvan VlietHHow organisation of architecture documentation affects architectural knowledge retrievalSci Comput Prog2016121759910.1016/j.scico.2015.10.014 – reference: Gelman A, Vehtari A, Simpson D, Margossian CC, Carpenter B, Yao Y, Kennedy L, Gabry J, Bürkner PC, Modrák M (2020) Bayesian workflow. https://arxiv.org/abs/2011.01808 – reference: JansenAAvgeriouPvan der VenJSEnriching software architecture documentationJ Syst Softw20098281232124810.1016/j.jss.2009.04.052 – reference: Brown A, Wilson G (2012) The Architecture of Open Source Applications. Lulu Inc. http://aosabook.org/en/index.html – reference: Díaz-PaceJAVillavicencioCSchiaffinoSNicolettiMVázquezHProducing just enough documentation: An optimization approach applied to the software architecture domainJ Data Semantics201651375310.1007/s13740-015-0053-0 – reference: BürknerPCVuorreMOrdinal regression models in psychology: A tutorialAdv Methods Practices Psychol Sci2019217710110.1177/2515245918823199 – volume-title: Documenting Software Architectures: Views and Beyond year: 2010 ident: 10347_CR9 – volume: 116 start-page: 191 year: 2016 ident: 10347_CR7 publication-title: J Syst Softw doi: 10.1016/j.jss.2015.08.054 – ident: 10347_CR32 – volume: 27 start-page: 1413 issue: 5 year: 2016 ident: 10347_CR38 publication-title: Stat Comput doi: 10.1007/s11222-016-9696-4 – volume: 169 year: 2020 ident: 10347_CR4 publication-title: J Syst Software doi: 10.1016/j.jss.2020.110699 – ident: 10347_CR37 doi: 10.1145/3017680.3017737 – ident: 10347_CR17 doi: 10.1109/WICSA.2014.28 – ident: 10347_CR30 – ident: 10347_CR35 doi: 10.1109/ICSA.2017.15 – ident: 10347_CR15 – volume: 2 start-page: 77 issue: 1 year: 2019 ident: 10347_CR6 publication-title: Adv Methods Practices Psychol Sci doi: 10.1177/2515245918823199 – volume-title: A taxonomy for learning, teaching, and assessing : A revision of Bloom’s taxonomy of educational objectives year: 2001 ident: 10347_CR1 – volume: 5 start-page: 37 issue: 1 year: 2016 ident: 10347_CR12 publication-title: J Data Semantics doi: 10.1007/s13740-015-0053-0 – volume: 27 start-page: 1413 issue: 5 year: 2016 ident: 10347_CR39 publication-title: Stat Comput doi: 10.1007/s11222-016-9696-4 – volume: 82 start-page: 1232 issue: 8 year: 2009 ident: 10347_CR22 publication-title: J Syst Softw doi: 10.1016/j.jss.2009.04.052 – ident: 10347_CR11 doi: 10.1145/1806799.1806842 – ident: 10347_CR40 doi: 10.1109/ICSE.2015.54 – volume: 1 start-page: 27 issue: 1 year: 2018 ident: 10347_CR29 publication-title: Adv Methods Pract Psychol Sci doi: 10.1177/2515245917745629 – ident: 10347_CR19 doi: 10.1109/WICSA-ECSA.212.20 – volume: 31 start-page: 54 issue: 6 year: 2014 ident: 10347_CR14 publication-title: IEEE Softw doi: 10.1109/MS.2014.107 – volume: 31 start-page: 1 issue: 3 year: 2022 ident: 10347_CR16 publication-title: ACM Trans Softw Eng Methodol doi: 10.1145/3490953 – ident: 10347_CR21 doi: 10.1109/ESEM.2011.25 – ident: 10347_CR10 doi: 10.1007/978-3-540-77619-2_14 – ident: 10347_CR8 doi: 10.1145/2786805.2786854 – volume: 48 start-page: 2053 issue: 6 year: 2021 ident: 10347_CR36 publication-title: IEEE Trans Software Eng doi: 10.1109/TSE.2020.3048991 – volume: 30 issue: 4 year: 2018 ident: 10347_CR3 publication-title: J Softw Evol Process doi: 10.1002/smr.1921 – ident: 10347_CR5 – volume: 59 start-page: 67 year: 2015 ident: 10347_CR33 publication-title: Inf Softw Technol doi: 10.1016/j.infsof.2014.11.001 – volume: 56 start-page: 545 issue: 6 year: 2014 ident: 10347_CR13 publication-title: Inf Softw Tech doi: 10.1016/j.infsof.2014.01.008 – ident: 10347_CR2 doi: 10.1007/978-3-540-77619-2_12 – volume: 12 start-page: 42 issue: 6 year: 1995 ident: 10347_CR24 publication-title: IEEE Software doi: 10.1109/52.469759 – ident: 10347_CR28 doi: 10.1145/2884781.2884792 – ident: 10347_CR25 doi: 10.1109/MSR.2015.45 – volume: 121 start-page: 75 year: 2016 ident: 10347_CR20 publication-title: Sci Comput Prog doi: 10.1016/j.scico.2015.10.014 – ident: 10347_CR18 – volume-title: Statistical Rethinking year: 2020 ident: 10347_CR27 doi: 10.1201/9780429029608 – volume: 25 start-page: 4427 issue: 6 year: 2020 ident: 10347_CR23 publication-title: Empir Softw Eng doi: 10.1007/s10664-020-09835-6 – ident: 10347_CR26 doi: 10.1109/ICGSE.2017.11 – ident: 10347_CR31 doi: 10.1145/2038476.2038517 – volume: 36 start-page: 41 issue: 4 year: 2019 ident: 10347_CR34 publication-title: IEEE Software doi: 10.1109/MS.2018.110162131 |
| SSID | ssj0009745 |
| Score | 2.3726184 |
| Snippet | Documentation is an important mechanism for disseminating software architecture knowledge. Software project teams can employ vastly different formats for... |
| SourceID | proquest crossref springer |
| SourceType | Aggregation Database Enrichment Source Index Database Publisher |
| StartPage | 122 |
| SubjectTerms | Architecture Compilers Computer architecture Computer Science Documentation Documents Format Interpreters Narratives Programming Languages Questions Software Software Engineering/Programming and Operating Systems Source code |
| SummonAdditionalLinks | – databaseName: SpringerLink Journals (ICM) dbid: U2A link: http://utb.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwlV09T8MwED1BWVj4RhQK8sAGlnBsJ_FYIaoKCSYqdbPi2J4gRW0Rf5-z65CCAIk5jodL7t473d07gEtVIYZIYanJbUVFKWuquHE0t5jheitEFptoHh7z8UTcT-U0DYUt2m73tiQZI_XasFueC4oYg6GDB32BTdiSmLuHRq5JNuykdou4mjiI61GOiJ5GZX6-4yscdRzzW1k0os1oD3YSTSTD1Xfdhw3XHMBuu4KBJI88hGxIokAsmXliZ_XbSxolagiSUbLAGPtezR1ZLxccwWR093Q7pmkNAq3RP5bUl8YbpgppGLPS-KKwzFlvXKlKoRymINJImVlrjPOuMkHDylelCEpuN9wqfgy9Zta4EyBM1c5Y5Cy-MIIjEhW-ChxROuRBqir6wFpr6DpphIdVFc-6UzcOFtRoQR0tqLM-XH2-87pSyPjz9KA1sk7estBhOpbxUBLuw3Vr-O7x77ed_u_4GWyHbfGrFrEB9JbzN3eOnGJpLuIv9AF0KsBb priority: 102 providerName: Springer Nature |
| Title | A study of documentation for software architecture |
| URI | https://link.springer.com/article/10.1007/s10664-023-10347-2 https://www.proquest.com/docview/2865137272 |
| Volume | 28 |
| hasFullText | 1 |
| inHoldings | 1 |
| isFullTextHit | |
| isPrint | |
| link | http://utb.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwfV3JTsMwEB3R9oKQWAqIQql84AYWJLGznFBAXQSiQohK5RTFsX2CtHQRv884dUhBotcsljITzzx7PO8BXEQp5hDOJBW-TCkLeUYjTyjqS1zhasmYWxyieRr6gxF7GPOx3XCb22OVZUwsArWcZGaP_Np0UDqeKRveTj-pUY0y1VUroVGDBobgMKxD4647fH6paHeDQqbYEO1RD7O7bZuxzXO-zyjmLAxFnuEr-J2aKrz5p0RaZJ7ePuxayEjilY8PYEvlTdiJ1yoATdgr1RmInayH4Mak4I4lE03w85YftssoJ4hTyRzD71c6U2S9knAEo1739X5ArUICzXDqLKgOhRZOFHDhOJILHQTSUVILFUYhixSuTrjg3JVSCKVVKgy9lU5DZkjebjwZecdQzye5OgHiRJkSEuGMDgTzMEkFOjXwkSuESFEatMApjZNklj7cqFi8JxXxsTFoggZNCoMmbgsuf96ZrsgzNj7dLm2e2Ik0Tyq3t-Cq9EN1-__RTjePdgbbRjh-dVqsDfXFbKnOEV4sRAdqYa_fgUbcf3vsduwfhVdHbvwNPzLNSQ |
| linkProvider | ProQuest |
| linkToHtml | http://utb.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwtV3JTsMwEB2hcgAhsRQQhQI-wAksSGJnOSBUAaWly6mVegtxbJ-gLV1U8VN8I-M0IQWJ3npO4sPLZOY543kP4CKIsIZwJqlwZUSZz2MaOEJRV-IOV0vG7OQQTavt1rrspcd7a_CVzcKYY5VZTkwStRzE5h_5jZmgtBzTNrwfflDjGmW6q5mFxjwsGupzhlu28V39Ed_vpW1XnzoPNZq6CtAYw21CtS-0sAKPC8uSXGjPk5aSWig_8FmgkNFzwbktpRBKq0gYSSgd-cwIo9060ogvYcpfZw5WcjOZXn3ORX69xBTZyPpRB7lEOqSTjuq5LqNYITHxOUYd4XchzNntn4ZsUuequ7CdElRSmUfUHqypfhG2Kgv9hiLsZF4QJE0N-2BXSKJUSwaaIJjT93SmqU-QFZMxJvtZNFJksW9xAN2VIHcIhf6gr46AWEGshETypD3BHCyJno4MWeUKCVkQeSWwMnDCOBUrN54Zb2Eus2wADRHQMAE0tEtw9fPMcC7VsfTucoZ5mH624zAPshJcZ-8hv_z_asfLVzuHjVqn1Qyb9XbjBDaNZf38nFoZCpPRVJ0isZmIsySaCLyuOny_AU9cBuU |
| linkToPdf | http://utb.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwtV3JTsMwEB1VrYQQEjuiUMAHOIEFSewsB4TKUhUKFUIgcQtxbJ-gLV1U8Wt8HePUIQUJbj0n8eF5PPOcmXkDsB8lGEM4k1T4MqEs5CmNPKGoL_GGqyVjblZEc9f2m0_s5pk_l-Az74UxZZW5T8wcteym5h_5semgdDyTNjzWtizi_rJx1nunZoKUybTm4zQmJtJSH2O8vg1Ory9xrw9ct3H1eNGkdsIATdH0hlSHQgsnCrhwHMmFDgLpKKmFCqOQRQrZPRecu1IKobRKhJGH0knIjEjaiSeNEBO6_0pgbkVlqJxfte8fCsnfIBuRbET-qIfMwrbs2MY932cU4yW6Qc9oJfwMiwXX_ZWezaJeYxkWLV0l9Yl9rUBJdVZhoT6VfViFpXwyBLGOYg3cOsl0a0lXE4R29GY7nDoEOTIZoOsfJ31FprMY6_A0E-w2oNzpdtQmECdKlZBIpXQgmIcBMtCJoa5cIT2LkqAKTg5OnFrpcjNB4zUuRJcNoDECGmeAxm4VDr-_6U2EO_59u5ZjHttDPIgLk6vCUb4PxeO_V9v6f7U9mEPTjW-v261tmDfz6ydFazUoD_sjtYMsZyh2rTkReJm1BX8BBaQMdw |
| openUrl | ctx_ver=Z39.88-2004&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&rfr_id=info%3Asid%2Fsummon.serialssolutions.com&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=article&rft.atitle=A+study+of+documentation+for+software+architecture&rft.jtitle=Empirical+software+engineering+%3A+an+international+journal&rft.au=Ernst%2C+Neil+A&rft.au=Robillard%2C+Martin+P&rft.date=2023-09-01&rft.pub=Springer+Nature+B.V&rft.issn=1382-3256&rft.eissn=1573-7616&rft.volume=28&rft.issue=5&rft.spage=122&rft_id=info:doi/10.1007%2Fs10664-023-10347-2&rft.externalDBID=HAS_PDF_LINK |
| thumbnail_l | http://covers-cdn.summon.serialssolutions.com/index.aspx?isbn=/lc.gif&issn=1382-3256&client=summon |
| thumbnail_m | http://covers-cdn.summon.serialssolutions.com/index.aspx?isbn=/mc.gif&issn=1382-3256&client=summon |
| thumbnail_s | http://covers-cdn.summon.serialssolutions.com/index.aspx?isbn=/sc.gif&issn=1382-3256&client=summon |