Preliminary Report on Empirical Study of Repeated Fragments in Internal Documentation

Nosal, Milan; Porubãn, Jaroslav

doi:10.15439/2016f524

Cited by 4 publications

(6 citation statements)

References 11 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…In their further research [13], they examine exact duplicates in embedded documentation of several open-source projects, but do not consider near duplicates.…”

Section: Related Workmentioning

confidence: 99%

See 1 more Smart Citation

Interactive Near Duplicate Search in Software Documentation

Luciv¹,

Koznov²,

Shelikhovskii³

et al. 2019

Program Comput Soft

View full text Add to dashboard Cite

Various software features such as classes, methods, requirements, and tests often have similar functionality. This can lead to emergence of duplicates in their descriptive documentation. Uncontrolled duplicates created via copy/paste hinder the process of documentation maintenance. Therefore, the task of duplicate detection in software documentation is of importance. Solving it makes planned reuse possible, as well as creating and using templates for unification and automatic generation of documentation. In this paper, we present an interactive process for duplicate detection that involves the user in order to conduct meaningful search. It includes a new formal definition of a near duplicate, a pattern-based, and the proof of its completeness. Moreover, we demonstrate the results of experimenting on a collection of documents of several industrial projects.

show abstract

“…In their further research [13], they examine exact duplicates in embedded documentation of several open-source projects, but do not consider near duplicates.…”

Section: Related Workmentioning

confidence: 99%

“…Duplicates in software documentation have been extensively studied during the last decade [6,11,12,13,14,15,16,17]. At the same time, there are no specialized tools for duplicate detection.…”

Section: Introductionmentioning

confidence: 99%

Interactive Near Duplicate Search in Software Documentation

Luciv¹,

Koznov²,

Shelikhovskii³

et al. 2019

Program Comput Soft

View full text Add to dashboard Cite

show abstract

“…In [3] Nosál and Porubän present the results of a case study in which they searched for exact duplicates in internal documentation (source code comments) of an open source project set. They used a modified copy/paste detection tool, which was originally developed for code analysis and found considerable number of text duplicates.…”

Section: Related Workmentioning

confidence: 99%

“…The initial interval tree for is constructed using the () function (line 2). The core part of the algorithm is a loop in which new near duplicate groups are constructed (lines [3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18]…”

Section: Algorithm Descriptionmentioning

confidence: 99%

“…Textual duplicates in software documentation, both exact and near ones, are extensively studied [2,3,4,5]. However, there are no methods for detection of near duplicates, only for exact ones and mainly using software clone detection techniques [2,3,6]. At the same time Juergens et al [2] indicates the importance of near duplicates and recommends to "pay par-ticular attention to subtle differences in duplicated text".…”

Section: Introductionmentioning

confidence: 99%

See 1 more Smart Citation

Detecting Near Duplicates in Software Documentation

Luciv

Koznov

Chernishev

et al. 2018

Program Comput Soft

View full text Add to dashboard Cite

Contemporary software documentation is as complicated as the software itself. During its lifecycle, the documentation accumulates a lot of "near duplicate" fragments, i.e. chunks of text that were copied from a single source and were later modified in different ways. Such near duplicates decrease documentation quality and thus hamper its further utilization. At the same time, they are hard to detect manually due to their fuzzy nature. In this paper we give a formal definition of near duplicates and present an algorithm for their detection in software documents. This algorithm is based on the exact software clone detection approach: the software clone detection tool Clone Miner was adapted to detect exact duplicates in documents. Then, our algorithm uses these exact duplicates to construct near ones. We evaluate the proposed algorithm using the documentation of 19 open source and commercial projects. Our evaluation is very comprehensive -it covers various documentation types: design and requirement specifications, programming guides and API documentation, user manuals. Overall, the evaluation shows that all kinds of software documentation contain a significant number of both exact and near duplicates. Next, we report on the performed manual analysis of the detected near duplicates for the Linux Kernel Documentation. We present both quantative and qualitative results of this analysis, demonstrate algorithm strengths and weaknesses, and discuss the benefits of duplicate management in software documents.

show abstract

What do Researchers Need when Implementing Novel Interaction Techniques?

Raffaillac

Huot

2022

Proc. ACM Hum.-Comput. Interact.

View full text Add to dashboard Cite

Interaction frameworks are the tools of choice for researchers and UI designers when prototyping new and original interaction techniques. But with little knowledge about actual needs, these frameworks provide incomplete support that restricts, slows down or even prevents the exploration of new ideas. In this context, researchers resort to hacking methods, creating code that lacks robustness beyond experiments, combining libraries of different levels and paradigms, and eventually limiting the dissemination and reproducibility of their work. To better understand this problem, we interviewed 9 HCI researchers and conducted an online survey. From the results we give an overview of the criteria for choosing frameworks, the problems often met with them, and the "tricks" used as solutions. Then we propose three design principles to better support prototyping for research in UI frameworks: (i) duplicate singular elements (e.g. mouse, caret) to foster opportunities for extensions, (ii) accumulate rather than replace to keep a history of changes, and (iii) defer the execution of predefined behaviors to enable their monitoring and replacement.

show abstract

Preliminary Report on Empirical Study of Repeated Fragments in Internal Documentation

Cited by 4 publications

References 11 publications

Interactive Near Duplicate Search in Software Documentation

Interactive Near Duplicate Search in Software Documentation

Detecting Near Duplicates in Software Documentation

What do Researchers Need when Implementing Novel Interaction Techniques?

Contact Info

Product

Resources

About