How software engineers use documentation: the state of the practice

Lethbridge, Timothy C.; Singer, Janice; Forward, Andrew

doi:10.1109/ms.2003.1241364

Cited by 273 publications

(164 citation statements)

References 4 publications

Supporting

Mentioning

154

Contrasting

Unclassified

Order By: Relevance

“…However, developing acceptance tests from requirements specifications is a subjective process that does not guarantee that all requirements are covered (Hsia 1997). This is further complicated by requirements documentation rarely being updated (Lethbridge 2003), leading to potentially outdated acceptance tests. In agile development, automated acceptance tests drive the implementation and address these issues by documenting requirements and expected outcomes in an executable format (Ramesh 2010, Haugset 2008).…”

Section: The Agile Approach Of Integrating Requirements Engineering Wmentioning

confidence: 99%

A multi-case study of agile requirements engineering and the use of test cases as requirements

Bjarnason

Unterkalmsteiner

Borg

et al. 2016

Information and Software Technology

View full text Add to dashboard Cite

Section: The Agile Approach Of Integrating Requirements Engineering Wmentioning

confidence: 99%

A multi-case study of agile requirements engineering and the use of test cases as requirements

Bjarnason

Unterkalmsteiner

Borg

et al. 2016

Information and Software Technology

View full text Add to dashboard Cite

“…Credibility of information AK often changes in large and complex systems and the cost to update is sometimes prohibitive [19]. Documentation is quickly outdated and its users lose confidence in its credibility [23].…”

Section: Assessment Of Design Maturitymentioning

confidence: 99%

How organisation of architecture documentation affects architectural knowledge retrieval

Graaf¹,

Liang

Tang

et al. 2016

Science of Computer Programming

View full text Add to dashboard Cite

A common approach to software architecture documentation in industry projects is the use of file-based documents. This approach offers a single-dimensional arrangement of the architectural knowledge. Knowledge retrieval from file-based architecture documentation is efficient if the organisation of knowledge supports the needs of the readers; otherwise it can be difficult. In this paper, we compare the organisation and retrieval of architectural knowledge in a file-based documentation approach and an ontologybased documentation approach. The ontology-based approach offers a multi-dimensional organisation of architectural knowledge by means of a software ontology and semantic wiki, whereas file-based documentation typically uses hierarchical organisation by directory structure and table of content. We conducted case studies in two companies to study the efficiency and effectiveness of retrieving architectural knowledge from the different organisations of knowledge. We found that the use of better knowledge organisation correlates with the efficiency and effectiveness of AK retrieval. Professionals who used the knowledge organisation found this beneficial.

show abstract

“…Our formulas assign higher support to those alternative patterns that are frequent in NSD and are infrequent in 1 Recall that we discard itemsets that partially support fi i Node node = (Node) obj; 10:…”

Section: Solutionmentioning

confidence: 99%

“…However, in practice, these programming rules are often not well documented for Application Programming Interfaces (APIs) due to various factors such as hard project delivery deadlines and limited resources in the software development process [1]. To tackle the issue of lacking documented programming rules, various approaches have been developed in the past decade to mine programming rules from program executions [2]- [4], individual versions [5]- [12], or version histories [13], [14] of program source code.…”

Section: Introductionmentioning

confidence: 99%

Alattin: Mining Alternative Patterns for Detecting Neglected Conditions

Thummalapenta

Xie

2009

2009 IEEE/ACM International Conference on Automated Software Engineering

View full text Add to dashboard Cite

Abstract-To improve software quality, static or dynamic verification tools accept programming rules as input and detect their violations in software as defects. As these programming rules are often not well documented in practice, previous work developed various approaches that mine programming rules as frequent patterns from program source code. Then these approaches use static defect-detection techniques to detect pattern violations in source code under analysis. These existing approaches often produce many false positives due to various factors. To reduce false positives produced by these mining approaches, we develop a novel approach, called Alattin, that includes a new mining algorithm and a technique for detecting neglected conditions based on our mining algorithm. Our new mining algorithm mines alternative patterns in example form "P1 or P2", where P1 and P2 are alternative rules such as condition checks on method arguments or return values related to the same API method. We conduct two evaluations to show the effectiveness of our Alattin approach. Our evaluation results show that (1) alternative patterns reach more than 40% of all mined patterns for APIs provided by six open source libraries; (2) the mining of alternative patterns helps reduce nearly 28% of false positives among detected violations.

show abstract

How software engineers use documentation: the state of the practice

Cited by 273 publications

References 4 publications

A multi-case study of agile requirements engineering and the use of test cases as requirements

A multi-case study of agile requirements engineering and the use of test cases as requirements

How organisation of architecture documentation affects architectural knowledge retrieval

Alattin: Mining Alternative Patterns for Detecting Neglected Conditions

Contact Info

Product

Resources

About