Enriching software architecture documentation

Jansen, Anton; Avgeriou, Paris; Ven, Jan Salvador van der

doi:10.1016/j.jss.2009.04.052

Cited by 75 publications

(47 citation statements)

References 45 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…provide evidence in [8] that use of ontology-based documentation leads to increased architectural understanding during architectural reviews. Su et al propose use of an ontology for visualization and non-linear navigation of SA documentation which reduces the cognitive load on its users [10].…”

Section: Ontology-based Sa Documentationmentioning

confidence: 89%

“…Users of ontology-based SA documentation can retrieve AK using a semantic wiki [7] or plug-ins in text-editors [8]. Semantic wikis allow for web-based visualization and management of (ontology and its instances in) knowledge bases and semantic-enhanced search facilities such as graph-like exploration, faceting, and filtering of knowledge instances based on semantic interrelations.…”

Section: Ontology-based Sa Documentationmentioning

confidence: 99%

“…One can use a predefined ontology (as in [7]) or build an ontology specifically for a software project domain. A domain specific ontology can be built, e.g., by letting document authors and architects identify AK concepts in existing SA documentation [8].…”

Section: Ontology Engineering For Sa Documentationmentioning

confidence: 99%

“…The approach proposed by Jansen et al in [8] is, to our current knowledge, the only approach aimed at deriving a domain specific ontology for ontology-based SA documentation.…”

Section: Ontology Engineering For Sa Documentationmentioning

confidence: 99%

“…Jansen et al describe how they construct an ontology from existing SA documentation in [8]. Researchers and a software architect identified and annotated classes of AK in documentation text, to elicit the AK needs in a documentation use case about architectural reviews.…”

Section: Related Workmentioning

confidence: 99%

See 4 more Smart Citations

An exploratory study on ontology engineering for software architecture documentation

Graaf¹,

Liang

Tang

et al. 2014

Computers in Industry

View full text Add to dashboard Cite

Architectural Knowledge (AK) can be retrieved by the stakeholders in a software project.Recent findings show that the use of ontology-based SA documentation is promising. However, different roles in software development have different needs for AK, and building an ontology to suit these needs is challenging. In this paper we describe an approach to build an ontology for SA documentation. This approach involves the use of typical questions for eliciting and constructing an ontology. We outline eight contextual factors, which influence the successful construction of an ontology, especially in complex software projects with diverse AK users. We tested our 'typical question' approach in a case study and report how it can be used for acquiring and modeling AK needs.

show abstract

Section: Ontology-based Sa Documentationmentioning

confidence: 89%

Section: Ontology-based Sa Documentationmentioning

confidence: 99%

Section: Ontology Engineering For Sa Documentationmentioning

confidence: 99%

“…The approach proposed by Jansen et al in [8] is, to our current knowledge, the only approach aimed at deriving a domain specific ontology for ontology-based SA documentation.…”

Section: Ontology Engineering For Sa Documentationmentioning

confidence: 99%

Section: Related Workmentioning

confidence: 99%

See 3 more Smart Citations

An exploratory study on ontology engineering for software architecture documentation

Graaf¹,

Liang

Tang

et al. 2014

Computers in Industry

View full text Add to dashboard Cite

show abstract

An optimization‐based tool to support the cost‐effective production of software architecture documentation

Nicoletti

Schiaffino

Díaz-Pace

2015

J Software Evolu Process

View full text Add to dashboard Cite

Abstract. Some of the challenges faced by most software projects are tight budget constraints and schedules, which often make managers and developers prioritize the delivery of a functional product over other engineering activities, such as software documentation. In particular, having little or low-quality documentation of the software architecture of a system can have negative consequences for the project, as the architecture is the main container of the key design decisions to fulfill the stakeholders' goals. To further complicate this situation, generating and maintaining architectural documentation is a non-trivial and time-consuming activity. In this context, we present a tool approach that aims at (i) assisting the documentation writer in their tasks and (ii) ensuring a cost-effective documentation process by means of optimization techniques. Our tool, called SADHelper, follows the principle of producing reader-oriented documentation, in order to focus the available, and often limited, resources on generating just enough documentation that satisfies the stakeholders' concerns. The approach was evaluated in two experiments with users of software architecture documents, with encouraging results. These results show evidence that our tool can be useful to reduce the documentation costs and even improve the documentation quality, as perceived by their stakeholders.

show abstract

Richen: Automated enrichment of Git documentation with usage examples and scenarios

Shen,

Yang,

Jia

et al. 2024

J Software Evolu Process

View full text Add to dashboard Cite

As the predominant modern version control system, Git has become an indispensable tool for both commercial and open‐source software projects. It substantially improves software development effectiveness and efficiency through its distributed version control system, fostering seamless collaboration among teams and across locations. However, research has found that many developers have doubts about using Git commands, while the official Git documentation is rather scanty, that is, lacking sufficient explanations and examples. To help developers learn and use Git commands, we propose the first approach (Richen) for enriching Git documentation with usage examples and scenarios by leveraging crowd knowledge from Stack Overflow. Richen retrieves Git‐related posts from Stack Overflow, extracts relevant Q&A pairs, and selects representative command usages, including usage examples and scenarios, for different Git commands. Experimental results have shown that Richen can extract informative and concise command usages for Git commands. Compared with alternative methods adapted from API usage mining, the command usages obtained by Richen have significant advantages in terms of relevance, readability, and usability. Furthermore, we have shown through an empirical study that the command usages extracted by Richen can better help developers complete Git command‐related tasks.

show abstract

Enriching software architecture documentation

Cited by 75 publications

References 45 publications

An exploratory study on ontology engineering for software architecture documentation

An exploratory study on ontology engineering for software architecture documentation

An optimization‐based tool to support the cost‐effective production of software architecture documentation

Richen: Automated enrichment of Git documentation with usage examples and scenarios

Contact Info

Product

Resources

About