The relevance of software documentation, tools and technologies

Forward, Andrew; Lethbridge, Timothy C.

doi:10.1145/585064.585065

Cited by 27 publications

(35 citation statements)

References 0 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…It is possible that other kinds of runtime exceptions occur during the execution, for example, divide-by-zero. In most cases, such implicit exceptions are caused by programming errors, so it might be inappropriate to include them in the documentation [15]. Therefore, we adopt a similar strategy as in [16] and omit implicit exception extraction.…”

Section: Discussionmentioning

confidence: 99%

“…First the algorithm iterates the statements in m. If ) If the statement itself is a composite block, we recursively go through the internal statements of the block, and extract the corresponding exception information (line [7][8][9][10]. If the statement invokes another method call, and m's argument(s) is(are) passed onto the callee method n, we will use the recursion with parameters -the statement body of the callee method as the parameter, together with the depth value decreased by 1 (line [12][13][14][15]. The reason why we require the parameter match in the invocation case is to track and guarantee the constraints are on the same parameter list from the caller method.…”

Section: A Extract Constraints From Api Source Codementioning

confidence: 99%

See 1 more Smart Citation

Analyzing APIs Documentation and Code to Detect Directive Defects

Zhou

Chen

et al. 2017

2017 IEEE/ACM 39th International Conference on Software Engineering (ICSE)

100

View full text Add to dashboard Cite

Abstract-Application Programming Interface (API) documents represent one of the most important references for API users. However, it is frequently reported that the documentation is inconsistent with the source code and deviates from the API itself. Such inconsistencies in the documents inevitably confuse the API users hampering considerably their API comprehension and the quality of software built from such APIs. In this paper, we propose an automated approach to detect defects of API documents by leveraging techniques from program comprehension and natural language processing. Particularly, we focus on the directives of the API documents which are related to parameter constraints and exception throwing declarations. A first-order logic based constraint solver is employed to detect such defects based on the obtained analysis results. We evaluate our approach on parts of well documented JDK 1.8 APIs. Experiment results show that, out of around 2000 API usage constraints, our approach can detect 1146 defective document directives, with a precision rate of 81.6%, and a recall rate of 82.0%, which demonstrates its practical feasibility.

show abstract

Section: Discussionmentioning

confidence: 99%

Section: A Extract Constraints From Api Source Codementioning

confidence: 99%

Analyzing APIs Documentation and Code to Detect Directive Defects

Zhou

Chen

et al. 2017

2017 IEEE/ACM 39th International Conference on Software Engineering (ICSE)

100

View full text Add to dashboard Cite

show abstract

“…Relative to software documentation, Forward and Lethbridge [10] present the results of a survey of software professionals with the aim of uncovering the perceived relevance of software documentation, as well as the tools and technologies used to maintain, verify and validate such documents.…”

Section: Document Engineering: Reviewing a Few Abstractmentioning

confidence: 99%

Document engineering approaches toward scalable and structured multimedia, web and printable documents

Pimentel

Bulterman

Soares

2009

Multimed Tools Appl

View full text Add to dashboard Cite

Document engineering is the computer science discipline that investigates systems for documents in any form and in all media. As with the relationship between software engineering and software, document engineering is concerned with principles, tools and processes that improve our ability to create, manage, and maintain documents (http://www.documentengineering.org). The ACM Symposium on Document Engineering is an annual meeting of researchers active in document engineering: it is sponsored by ACM by means of the ACM SIGWEB Special Interest Group. In this editorial, we first point to work carried out in the context of document engineering, which are directly related to multimedia tools and applications. We conclude with a summary of the papers presented in this special issue.

show abstract

“…Forward et al [2], in their survey about the general opinion of software professionals regarding the relevance of documentation and related tools, highlight the general consensus that documentation content is relevant and important. They also highlight a set of concerns that software documentation technologies should be more aware of professionals' requirements, opposed to blindly enforce documentation formats or tools.…”

Section: Introductionmentioning

confidence: 99%

Open Source Software Documentation Mining for Quality Assessment

Carvalho

Simões

Almeida

2013

Advances in Intelligent Systems and Computing

View full text Add to dashboard Cite

Abstract. Besides source code, the fundamental source of information about Open Source Software lies in documentation, and other non source code files, like README, INSTALL, or HowTo files, commonly available in the software ecosystem. These documents, written in natural language, provide valuable information during the software development stage, but also in future maintenance and evolution tasks. DMOSS 3 is a toolkit designed to systematically assess the quality of non source code text found in software packages. The toolkit handles a package as an attribute tree, and performs several tree traverse algorithms through a set of plugins, specialized in retrieving specific metrics from text, gathering information about the software. These metrics are later used to infer knowledge about the software, and composed together to build reports that assess the quality of specific features of the software. This paper discusses the motivations for this work, continues with a description of the toolkit implementation and design goals. Follows an example of its usage to process a software package, and the produced report. Finally some final remarks and trends for future work are presented.

show abstract

The relevance of software documentation, tools and technologies

Cited by 27 publications

References 0 publications

Analyzing APIs Documentation and Code to Detect Directive Defects

Analyzing APIs Documentation and Code to Detect Directive Defects

Document engineering approaches toward scalable and structured multimedia, web and printable documents

Open Source Software Documentation Mining for Quality Assessment

Contact Info

Product

Resources

About