检索结果-内蒙古大学图书馆

Reusable software documentation with phrase annotations

OPEN COMPUTER SCIENCE 2014年第4期4卷 242-258页

作者： Nosal, Milan Porubaen, Jaroslav Tech Univ Kosice Fac Elect Engn & Informat Dept Comp & Informat Letna 9 Kosice 04200 Slovakia

Problem: Reoccurring software documentation fragments called documentation phrases crosscut documentation body and introduce undesired redundancy. The redundancy imposes problems with software documentation development and evolution. Objective: We want to reduce the negative effect caused by documentation phrases redundancy by centralizing the documentation phrases sources. This way a documentation phrase will have a single source that can be used for maintenance and evolution. Method: We discuss the nature of documentation phrases and argue for the support of their parametrization. We present a new documentation phrase instantiation method based on source code annotations. The provides free IDE support for writing documentation and is aided by our tool prototype. Results and contributions: Our contributions of this paper include identification of documentation phrase parametrization and the annotation- based documentation phrase instantiation. The annotation- based documentation phrase instantiation method enables to reduce the effort needed for documentation development and evolution.

关键词： code comprehension software documentation documentation phrases source code annotations attribute-oriented programming crosscutting concerns

来源：评论

学校读者我要写书评

暂无评论

Learning to answer programming questions with software documentation through social context embedding

引用

INFORMATION SCIENCES 2018年 448卷 36-52页

作者： Li, Jing Sun, Aixin Xing, Zhenchang Nanyang Technol Univ Sch Comp Sci & Engn Singapore Singapore Australian Natl Univ Coll Engn & Comp Sci Canberra ACT Australia

Official software documentation provides a comprehensive overview of software usages, but not on specific programming tasks or use cases. Often there is a mismatch between the documentation and a question on a specific programming task because of different wordings. We observe from Stack Overflow that the best answers to programmers' questions often contain links to formal documentation. In this paper, we propose a novel deep-learning-to-answer framework, named QDLinker, for answering programming questions with software documentation. QDLinker learns from the large volume of discussions in community-based question answering site to bridge the semantic gap between programmers' questions and software documentation. Specifically, QDLinker learns question-documentation semantic representation from these question answering discussions with a four-layer neural network, and incorporates semantic and content features into a learning-to-rank schema. Our approach does not require manual feature engineering or external resources to infer the degree of relevance between a question and documentation. Through extensive experiments, results show that QDLinker effectively answers programming questions with direct links to software documentation. QDLinker significantly outperforms the baselines based on traditional retrieval models and Web search services dedicated for software documentation retrieval. The user study shows that QDLinker effectively bridges the semantic gap between the intent of a programming question and the content of software documentation. (C) 2018 Elsevier Inc. All rights reserved.

关键词： Community-based question answering software documentation Social context Neural network

来源：评论

学校读者我要写书评

暂无评论

Use a Pencil: On Writing software documentation Well and the Role of Autodocumentation

引用

COMPUTER 2024年第5期57卷 102-105页

作者： Laplante, Phil The Pennsylvania State University State College PA USA

Proficiency in technical writing is an important skill that all software engineers should develop, but there is a trend toward automation of documentation. This article discusses the past, present, and future of softw... 详细信息

关键词： Writing documentation software Design Engineering Profession software documentation User Manual Practical Conditions software Engineering Use Of Artificial Intelligence Automatic Generation software Teams Design Documents software Development Processing software Destiny Public Libraries

来源：评论

学校读者我要写书评

暂无评论

A DITA Case Study: Service Learning, software documentation, and Redesign

A DITA Case Study: Service Learning, Software Documentation,...

引用

IEEE International Professional Communication Conference

作者： Edgell, David A. Texas Tech Univ Lubbock TX 79409 USA

ISBN: (纸本)9781424420858

As a service-learning project in a graduate level technical communication class on technical manuals, Dr. Brian Still found an open-source software developer in Germany who needed documentation for his application. The class looked at various approaches to fulfilling the developer's needs including wikis, Darwin Information Typing Architecture (DITA), XML, usability testing, and software mapping. This paper touches on the successes and challenges of the project and examines the potential for using DITA as a solution for reconstructing existing documentation. Keywords: DITA, service-learning, software documentation, XML.

关键词： DITA service-learning software documentation XML

来源：评论

学校读者我要写书评

暂无评论

About face:: Comparing positive politeness in Dummies and conventional software documentation

About face:: Comparing positive politeness in <i>Dummies</i>...

引用

IEEE International Professional Communication Conference

作者： Riley, K Univ Minnesota Ctr Study Informat Design & Proc Dept Composit Duluth MN 55812 USA

ISBN: (纸本)0780379497

Previous researchers have noted rhetorical differences between primary manuals (i.e., those produced by the manufacturer) and secondary (i.e., after-market) manuals such as those in the Dummies series. Three manuals for Dreamweaver 4 software - the primary manual, the Dummies manual, and another secondary manual - were compared for their use of positive politeness strategies identified by Brown & Levinson within the theory of linguistic pragmatics. The Dummies manual uses a large variety and number of positive politeness strategies. These strategies account in large part for the unique tone of the Dummies manual. In addition, because positive politeness strategies serve to build rapport, these strategies may account for the popularity of the Dummies series. The theory of positive politeness provides a well-developed, systematic method for describing and explaining the way that tone is achieved through the use of specific linguistic features. Keywords: politeness, procedural discourse, software documentation, user's manuals.

关键词： politeness procedural discourse software documentation user's manuals

来源：评论

学校读者我要写书评

暂无评论

Beyond Accuracy: Assessing software documentation Quality 2020

Beyond Accuracy: Assessing Software Documentation Quality

引用

28th ACM Joint Meeting on European software Engineering Conference and Symposium on the Foundations of software Engineering (ESEC/FSE)

作者： Treude, Christoph Middleton, Justin Atapattu, Thushari Univ Adelaide Adelaide SA Australia North Carolina State Univ Raleigh NC USA

ISBN: (纸本)9781450370431

Good software documentation encourages good software engineering, but the meaning of "good" documentation is vaguely defined in the software engineering literature. To clarify this ambiguity, we draw on work from the data and information quality community to propose a framework that decomposes documentation quality into ten dimensions of structure, content, and style. To demonstrate its application, we recruited technical editors to apply the framework when evaluating examples from several genres of software documentation. We summarise their assessments-for example, reference documentation and README files excel in quality whereas blog articles have more problems-and we describe our vision for reasoning about software documentation quality and for the expansion and potential of a unified quality framework.

关键词： software documentation quality

来源：评论

学校读者我要写书评

暂无评论

Extraction of archetype from near duplicates in software documentation

Extraction of archetype from near duplicates in software doc...

引用

6th Conference on Actual Problems of Systems and software Engineering (APSSE)

作者： Koznov, Dmitry Luciv, Dmitry Chernishev, George Grigoryev, Dmitry St Petersburg State Univ Software Engn Dept St Petersburg Russia St Petersburg State Univ Analyt Informat Syst Dept St Petersburg Russia St Petersburg State Univ Dept Comp Sci St Petersburg Russia

ISBN: (纸本)9781728160610

software documentation contains a large amount of duplicate text, which is often comprised of near duplicates - repetitions of the same text with slight differences. They emerge due to numerous copy-pastes that have been slightly modified. Uncontrolled near duplicates complicate documentation support to a significant degree. There are some research papers on detection and management of duplicates in software documentation, but only the Duplicate Finder approach addresses the problem of near duplicates. Nevertheless, Duplicate Finder's search algorithms do not provide extraction of archetype (common text) for detected groups of near duplicates (a set of near duplicates belong to one group if they have a lot of commonalities). Archetype of group can be used in visualization of the common text and differences of duplicates for manual analysis, as well as for reuse of documentation. In this paper, we present an algorithm for archetype extraction and results of experiments on documentation of several well-known open source Java projects JUnit, Mockito, SLF4J.

关键词： software documentation JavaDoc Duplicates Near Duplicates

来源：评论

学校读者我要写书评

暂无评论

Choosing an NLP Library for Analyzing software documentation: A Systematic Literature Review and a Series of Experiments 14

Choosing an NLP Library for Analyzing Software Documentation...

引用

IEEE/ACM 14th International Conference on Mining software Repositories (MSR)

作者： Al Omran, Fouad Nasser A. Treude, Christoph Univ Adelaide Sch Comp Sci Adelaide SA Australia

ISBN: (纸本)9781538615447

To uncover interesting and actionable information from natural language documents authored by software developers, many researchers rely on "out-of-the-box" NLP libraries. However, software artifacts written in natural language are different from other textual documents due to the technical language used. In this paper, we first analyze the state of the art through a systematic literature review in which we find that only a small minority of papers justify their choice of an NLP library. We then report on a series of experiments in which we applied four state-of-the-art NLP libraries to publicly available software artifacts from three different sources. Our results show low agreement between different libraries (only between 60% and 71% of tokens were assigned the same part-of-speech tag by all four libraries) as well as differences in accuracy depending on source: For example, spaCy achieved the best accuracy on Stack Overflow data with nearly 90% of tokens tagged correctly, while it was clearly outperformed by Google's SyntaxNet when parsing GitHub ReadMe files. Our work implies that researchers should make an informed decision about the particular NLP library they choose and that customizations to libraries might be necessary to achieve good results when analyzing software artifacts written in natural language.

关键词： Natural language processing NLP libraries Part-of-Speech tagging software documentation

来源：评论

学校读者我要写书评

暂无评论

Understanding Emotions of Developer Community Towards software documentation 43

Understanding Emotions of Developer Community Towards Softwa...

引用

43rd IEEE/ACM International Conference on software Engineering - Joint Track on software Engineering Education and Training (ICSE-JSEET) / IEEE/ACM 43rd International Conference on software Engineering -software Engineering in Society (ICSE-SEIS)

作者： Venigalla, Akhila Sri Manasa Chimalakonda, Sridhar Indian Inst Technol Tirupati Dept Comp Sci & Engn Res Intelligent Software & Human Analyt RISHA Lab Tirupati Andhra Pradesh India

ISBN: (纸本)9780738133225

The availability of open-source projects facilitates developers to contribute and collaborate on a wide range of projects. As a result, the developer community contributing to such open-source projects is also increasing. Many of the projects involve frequent updates and extensive reuses. A well-updated documentation helps in a better understanding of the software project and also facilitates efficient contribution and reuse. Though software documentation plays an important role in the development and maintenance of software, it also suffers from various issues that include insufficiency, inconsistency, ill-maintainability, and so on. Exploring the perception of developers towards documentation could help in understanding the reasons behind prevalent issues in software documentation. It could further aid in deciding on training that could be given to the developer community towards building more sustainable projects for society. Analyzing sentiments of contributors to a project could provide insights on understanding developer perceptions. Hence, as the first step towards this direction, we analyze sentiments of commit messages specific to the documentation of a software project. To this end, we considered the commit history of 998 GitHub projects from the GHTorrent dataset and identified 10,996 commits that correspond to the documentation of repositories. Further, we apply sentiment analysis techniques to obtain insights on the type of sentiment being expressed in commit messages of the selected commits. We observe that around 45% of the identified commit messages express trust emotion.

关键词： Developer Community Commit Messages software documentation Emotions GitHub

来源：评论

学校读者我要写书评

暂无评论

Generating software documentation in Use Case Maps from Filtered Execution Traces 17th

Generating Software Documentation in Use Case Maps from Filt...

引用

17th International System Design Languages Forum (SDL Forum)

作者： Braun, Edna Amyot, Daniel Lethbridge, Timothy C. Univ Ottawa Sch EECS Ottawa ON Canada

ISBN: (纸本)9783319249124;9783319249117

One of the main issues in software maintenance is the time and effort needed to understand software. software documentation and models are often incomplete, outdated, or non-existent, in part because of the cost and effort involved in creating and continually updating them. In this paper, we describe an innovative technique for automatically extracting and visualizing software behavioral models from execution traces. Lengthy traces are summarized by filtering out low-level software components via algorithms that utilize static and dynamic data. Eight such algorithms are compared in this paper. The traces are visualized using the Use Case Map (UCM) scenario notation. The resulting UCM diagrams depict the behavioral model of software traces and can be used to document the software. The tool-supported technique is customizable through different filtering algorithms and parameters, enabling the generation of documentation and models at different levels of abstraction.

关键词： Feature location software documentation Trace summarization Use Case Map Utility Visualization

来源：评论

学校读者我要写书评

暂无评论

建议与咨询留下您的常用邮箱和电话号码，以便我们向您反馈解决方案和替代方法

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

请选择保存的检索档案：

请选择收藏分类：

通借通还

建议与咨询 留下您的常用邮箱和电话号码，以便我们向您反馈解决方案和替代方法

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

请选择保存的检索档案： 新增检索档案 确定 取消

请选择收藏分类： 新增自定义分类 确定 取消

通借通还

建议与咨询留下您的常用邮箱和电话号码，以便我们向您反馈解决方案和替代方法

请选择保存的检索档案：

请选择收藏分类：