How Do Open Source Communities Document Software Architecture: An Exploratory Survey

@article{Ding2014HowDO,
  title={How Do Open Source Communities Document Software Architecture: An Exploratory Survey},
  author={Wei Ding and Peng Liang and A. Tang and H. V. Vliet and Mojtaba Shahin},
  journal={2014 19th International Conference on Engineering of Complex Computer Systems},
  year={2014},
  pages={136-145}
}
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. [...] Key Result 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.Expand
Evaluating the Effects of Architectural Documentation: A Case Study of a Large Scale Open Source Project
TLDR
Analysis of the effects of introducing architectural documentation into a substantial open source project-the Hadoop Distributed File System (HDFS) finds that those on the periphery of the project-newcomers and adopters-still require explicit architecture documentation, as it appears. Expand
Empowering Empirical Research in Software Design: Construction and Studies on a Large-Scale Corpus of UML Models
TLDR
This study shows that the use of UML modeling has a positive impact on software quality, i.e. it correlates with lower defect proneness, and that visualisation of design concepts, such as class role-stereotypes, helps developers to perform better in software comprehension tasks. Expand
FourD: do developers discuss design? revisited
TLDR
A sample of commit messages from a random sample of projects on GitHub and SourceForge are manually classified as "design" or "non-design" based on a survey in order to determine if it is possible to predict whether or not a single commit is discussing software design. Expand
Towards Consistency Analysis between Formal and Informal Software Architecture Artefacts
  • Jan Keim, Yves Schneider, A. Koziolek
  • Computer Science
  • 2019 IEEE/ACM 2nd International Workshop on Establishing the Community-Wide Infrastructure for Architecture-Based Software Engineering (ECASE)
  • 2019
TLDR
This paper presents their long-term vision, where they plan to persist information from any sources, e.g. from whiteboard discussions, to avoid losing crucial information about a system, and addresses consistency analyses between models and textual natural language artefacts using natural language understanding. Expand
Towards Consistency Checking Between Software Architecture and Informal Documentation
  • Jan Keim, A. Koziolek
  • Computer Science
  • 2019 IEEE International Conference on Software Architecture Companion (ICSA-C)
  • 2019
TLDR
This paper presents a long-term vision, where all information from any sources are persisted to avoid losing crucial information about a system, and plans to address checking the consistency between models and textual natural language artefacts using natural language understanding. Expand
A survey on software architectural assumptions
TLDR
The results emphasize the need for a widely accepted understanding of the AA concept in software development, and specific approaches, tools, and guidelines to support AA identification and recording. Expand
The quest for open source projects that use UML: mining GitHub
TLDR
A semi-automated approach to collect UML stored in images, .xmi, and .uml files and scanned ten percent of all GitHub projects to answer the question when models, if used, are created and updated throughout the whole project's life-span. Expand
Exploring the suitability of source code metrics for indicating architectural inconsistencies
TLDR
Light is shed on the extent to which source code metrics on their own can be used to characterize classes contributing to software architecture degradation, and the fan-in metric seems to be a particularly interesting indicator. Expand
Software Documentation Management Issues and Practices: A Survey
TLDR
A study of all the issues and practices for documentation management revealed that documentation processes should be tailor made for every project according to the various factors that determine the documentation needs for a project. Expand
An industrial case study on an architectural assumption documentation framework
TLDR
This work proposed and validated an Architectural Assumption Documentation Framework (AADF), which is composed of four viewpoints, to document AAs in projects, and found that AADF can be understood by architects in a short time. Expand
...
1
2
3
4
...

References

SHOWING 1-10 OF 69 REFERENCES
Software Architecture Documentation for Developers: A Survey
TLDR
A survey with 147 industrial participants confirmed the common belief that architecture documentation is most frequently outdated and inconsistent and backed it up with data. Expand
Knowledge-based approaches in software documentation: A systematic literature review
TLDR
There is a need to use knowledge-based approaches to improve the quality attributes of software documents that receive less attention, especially credibility, conciseness, and unambiguity. Expand
Software architecture awareness in long-term software product evolution
Software architecture has been established in software engineering for almost 40 years. When developing and evolving software products, architecture is expected to be even more relevant compared toExpand
The Importance of Architectural Knowledge in Integrating Open Source Software
TLDR
An exploratory empirical study into the importance of AK of OSS components in integration and a research agenda to further the research field of software architecture in OSS are provided. Expand
Software documentation: how much is enough?
  • L. Briand
  • Computer Science
  • Seventh European Conference onSoftware Maintenance and Reengineering, 2003. Proceedings.
  • 2003
TLDR
This keynote address focuses on object-oriented development and the Unified Modeling Language (UML) and aims to better understand what type of documentation is required, what is needed to support its completeness and consistency, and what is the level of precision required for each type of document. Expand
A comparative study of challenges in integrating Open Source Software and Inner Source Software
TLDR
It is found that many challenges identified in the case study could be mapped to challenges related to integration of OSS, and may help organizations to understand how to improve their software development practices by adopting certain OSSD practices. Expand
Free/Open Source Software Development: Recent Research Results and Methods
TLDR
This chapter reviews what is known about free and open source software development (FOSSD) work practices, development processes, project and community dynamics, and other socio-technical relationships, and seeks to explore how FOSS is developed and evolved. Expand
How software engineers use documentation: the state of the practice
TLDR
The results confirm the widely held belief that SEs typically do not update documentation as timely or completely as software process personnel and managers advocate, however, the results also reveal that out-of-date software documentation remains useful in many circumstances. Expand
Understanding knowledge sharing activities in free/open source software projects: An empirical study
TLDR
The altruistic sharing of knowledge between knowledge providers and knowledge seekers in the Developer and User mailing lists of the Debian project is discussed and the knowledge sharing activity of self-organizing Free/Open Source communities could best be explained in terms of what is called ''Fractal Cubic Distribution'' rather than the power-law distribution mostly reported in the literature. Expand
Software Development: An Open Source Approach
To understand the principles and practice of software development, there is no better motivator than participating in a software project with real-world value and a life beyond the academic arena.Expand
...
1
2
3
4
5
...