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

Non-Linear software documentation with Interactive Code Examples

ACM TRANSACTIONS ON software ENGINEERING AND METHODOLOGY 2025年第2期34卷 1-32页

作者： Nassif, Mathieu Robillard, Martin P. McGill Univ Sch Comp Sci Montreal PQ Canada

documentation enables sharing knowledge between the developers of a technology and its users. Creating quality documents, however, is challenging: Documents must satisfy the needs of a large audience without being overwhelming for individuals. We address this challenge with a new document format named Casdoc. Casdoc documents are interactive resources centered around code examples for programmers. Explanations of the code elements are presented as annotations that the readers reveal based on their needs. We evaluated Casdoc in a field study with over 300 participants who used 126 documents as part of a software design course. During the study, the majority of participants adopted Casdoc instead of a baseline format and used interactive annotations to reveal additional information about the code example. Although participants collectively viewed the majority of the documents' content, they individually revealed a minority of the annotations they saw. We gathered insights into five aspects of Casdoc that can be applied to other formats and highlighted five lessons learned to improve navigability in online documents.

关键词： field study software documentation documentation format interactive documents code examples

来源：评论

学校读者我要写书评

暂无评论

software documentation with markdoc 5.0

引用

STATA JOURNAL 2020年第2期20卷 336-362页

作者： Haghish, E. F. Univ Gottingen Dept Med Psychol & Med Sociol Gottingen Germany

markdoc is a general-purpose literate programming package for generating dynamic documents, dynamic presentation slides, Stata help files, and package vignettes in various formats. In this article, I introduce markdoc version 5.0, which performs independently of any third-party software, using the mini engine. The mini engine is a lightweight alternative to Pandoc (MacFarlane [2006, https://***/]), completely written in Stata. I also propose a procedure for remodeling package documentation and data documentation in Stata and present a tutorial for generating help files, package vignettes, and GitHub Wiki documentation using markdoc.

关键词： pr0072 markdoc mini Pandoc statistics software software documentation literate programming social coding

来源：评论

学校读者我要写书评

暂无评论

software documentation and Augmented Reality: Love or Arranged Marriage? 2020

Software Documentation and Augmented Reality: Love or Arrang...

引用

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

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

ISBN: (纸本)9781450370431

There is a significant rise in the availability, development and size of software projects in the present day. Many open source projects are reused or updated for various purposes that include fixing bugs in existing projects, development and maintenance of project extensions. Developers who interact with the projects might require documentation for better comprehension of the project and to develop extensions. Most of the software projects currently do not have sufficient documentation or it is not updated along with the project. If some projects have reasonably sufficient documentation, it is usually difficult to comprehend it either for maintenance or for reuse purposes. Considering the usefulness of Augmented Reality (AR) towards comprehension, we propose the vision of integrating the domains of augmented reality and software documentation, and specifically, visualization of software documentation using AR. In this paper, we present some of the directions that could be explored towards this vision and also present an example visualization scenario for API documentation using neural system metaphor. We see this paper as a basis for the future research direction of leveraging AR towards making documentation as a primary artifact in the software development process.

关键词： Augmented Reality software documentation Visualization

来源：评论

学校读者我要写书评

暂无评论

QUALITY-CONTROL IN software documentation - MEASUREMENT OF TEXT COMPREHENSIBILITY

引用

INFORMATION & MANAGEMENT 1993年第3期25卷 133-146页

作者： LEHNER, F KOBLENZ SCH CORP MANAGEMENT INST BUSINESS INFORMATD-76179 VALLENDARGERMANY UNIV LINZ INST ORG RESLINZAUSTRIA

The importance of software documentation and the effects of poor documentation in data processing are often underrated. Little research has been published that evaluates its quality. software quality, on the other hand, is almost a buzzword. Discussions of software quality measurement often make reference to software documentation;however, the literature on the subject of software quality assurance has offered little adequate operationalization or usable instrument for quality measurement and quality control in software documentation. The paper provides a presentation of existing comprehensibility measures for texts and an inventory of available tools, a summary of experience with comprehensibility measures and tools published in the literature, the development of a tool for the computation of readability formulae, and the application of these measurement methods to software documentation in the context of an explorative case study.

关键词： documentation QUALITY QUALITY QUALITY CONTROL QUALITY MEASURES READABILITY software documentation TEXT COMPREHENSIBILITY TEXT COMPREHENSION

来源：评论

学校读者我要写书评

暂无评论

Extracting Development Tasks to Navigate software documentation

引用

IEEE TRANSACTIONS ON software ENGINEERING 2015年第6期41卷 565-581页

作者： Treude, Christoph Robillard, Martin P. Dagenais, Barthelemy Univ Fed Rio Grande do Norte Dept Informat & Matemat Aplicada BR-59072970 Natal RN Brazil McGill Univ Sch Comp Sci Montreal PQ Canada Resulto Montreal PQ Canada

Knowledge management plays a central role in many software development organizations. While much of the important technical knowledge can be captured in documentation, there often exists a gap between the information needs of software developers and the documentation structure. To help developers navigate documentation, we developed a technique for automatically extracting tasks from software documentation by conceptualizing tasks as specific programming actions that have been described in the documentation. More than 70 percent of the tasks we extracted from the documentation of two projects were judged meaningful by at least one of two developers. We present TaskNavigator, a user interface for search queries that suggests tasks extracted with our technique in an auto-complete list along with concepts, code elements, and section headers. We conducted a field study in which six professional developers used TaskNavigator for two weeks as part of their ongoing work. We found search results identified through extracted tasks to be more helpful to developers than those found through concepts, code elements, and section headers. The results indicate that task descriptions can be effectively extracted from software documentation, and that they help bridge the gap between documentation structure and the information needs of software developers.

关键词： software documentation development tasks navigation auto-complete natural language processing

来源：评论

学校读者我要写书评

暂无评论

Knowledge-based approaches in software documentation: A systematic literature review

引用

INFORMATION AND software TECHNOLOGY 2014年第6期56卷 545-567页

作者： Ding, Wei Liang, Peng Tang, Antony van Vliet, Hans Wuhan Univ Sch Comp State Key Lab Software Engn Wuhan Peoples R China Swinburne Univ Technol Fac Informat & Commun Technol Hawthorn Vic 3122 Australia Vrije Univ Amsterdam Dept Comp Sci Amsterdam Netherlands China Earthquake Adm Inst Seismol Key Lab Earthquake Geodesy Chengdu Peoples R China

Context: software documents are core artifacts produced and consumed in documentation activity in the software lifecycle. Meanwhile, knowledge-based approaches have been extensively used in software development for decades, however, the software engineering community lacks a comprehensive understanding on how knowledge-based approaches are used in software documentation, especially documentation of software architecture design. Objective: The objective of this work is to explore how knowledge-based approaches are employed in software documentation, their influences to the quality of software documentation, and the costs and benefits of using these approaches. Method: We use a systematic literature review method to identify the primary studies on knowledge-based approaches in software documentation, following a pre-defined review protocol. Results: Sixty studies are finally selected, in which twelve quality attributes of software documents, four cost categories, and nine benefit categories of using knowledge-based approaches in software documentation are identified. Architecture understanding is the top benefit of using knowledge-based approaches in software documentation. The cost of retrieving information from documents is the major concern when using knowledge-based approaches in software documentation. Conclusions: The findings of this review suggest several future research directions that are critical and promising but underexplored in current research and practice: (1) there is a need to use knowledge-based approaches to improve the quality attributes of software documents that receive less attention, especially credibility, conciseness, and unambiguity;(2) using knowledge-based approaches with the knowledge content in software documents which gets less attention in current applications of knowledge-based approaches in software documentation, to further improve the practice of software documentation activity;(3) putting more focus on the application of software

关键词： Knowledge-based approach software documentation Systematic literature review Knowledge activity software architecture design

来源：评论

学校读者我要写书评

暂无评论

Detecting Near Duplicates in software documentation

引用

PROGRAMMING AND COMPUTER software 2018年第5期44卷 335-343页

作者： Luciv, D., V Koznov, D., V Chernishev, G. A. Terekhov, A. N. Romanovsky, K. Yu Grigoriev, D. A. St Petersburg State Univ St Petersburg 199034 Russia

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.

关键词： software documentation near duplicates documentation reuse software clone detection

来源：评论

学校读者我要写书评

暂无评论

SODOS - A software documentation SUPPORT ENVIRONMENT - ITS USE

引用

IEEE TRANSACTIONS ON software ENGINEERING 1986年第11期12卷 1076-1087页

作者： HOROWITZ, E WILLIAMSON, RC HUGHES AIRCRAFT CO DIV SOFTWARE ENGNDEPT ARTIFICIAL INTELLIGENCE TECHNOLEL SEGUNDOCA 90245

A computerized environment called SODOS (software documentation Support) is described that supports the definition and manipulation of documents used in developing software. An object-oriented environment is employed as a basis for the SODOS interface. SODOS is constructed around a software Life Cycle model that structures all access to the documents stored in the environment. One benefit of this model is that it supports software documentation independent of any fixed methodology that the developers may be using. The system's main advantage is that it allows traceability through each phase of the Life Cycle, thereby facilitating the test and maintenance phases. Finally, the task of learning and using SODOS is simplified because of a sophisticated user-friendly interface. Illustrations.

关键词： software Databases documentation Syntactics Maintenance Engineering Browsers Manuals software Life Cycle Objects Requirements Traceability software Development Environment software documentation

来源：评论

学校读者我要写书评

暂无评论

Live software documentation of design pattern instances

引用

PEERJ COMPUTER SCIENCE 2024年 10卷 e2090页

作者： Lemos, Filipe Correia, Filipe F. Aguiar, Ademar Queiroz, Paulo G. G. Univ Porto Fac Engn Porto Portugal INESC TEC Porto Portugal Univ Fed Rural Semi Arido Mossoro RN Brazil

Background: Approaches to documenting the software patterns of a system can support intentionally and manually documenting them or automatically extracting them from the source code. Some of the approaches that we review do not maintain proximity between code and documentation. Others do not update the documentation after the code is changed. All of them present a low level of liveness. Approach: This work proposes an approach to improve the understandability of a software system by documenting the design patterns it uses. We regard the creation and the documentation of software as part of the same process and attempt to streamline the two activities. We achieve this by increasing the feedback about the pattern instances present in the code, during development-i.e., by increasing liveness. Moreover, our approach maintains proximity between code and documentation and allows us to visualize the pattern instances under the same environment. We developed a prototype-DesignPatternDoc-for IntelliJ IDEA that continuously identifies pattern instances in the code, suggests them to the developer, generates the respective pattern-instance documentation, and enables live editing and visualization of that documentation. Results: To evaluate this approach, we conducted a controlled experiment with 21 novice developers. We asked participants to complete three tasks that involved understanding and evolving small software systems-up to six classes and 100 lines of code-and recorded the duration and the number of context switches. The results show that our approach helps developers spend less time understanding and documenting a software system when compared to using tools with a lower degree of liveness. Additionally, embedding documentation in the IDE and maintaining it close to the source code reduces context switching significantly.

关键词： Design patterns Liveness software documentation

来源：评论

学校读者我要写书评

暂无评论

Leveraging Official Content and Social Context to Recommend software documentation

引用

IEEE TRANSACTIONS ON SERVICES COMPUTING 2021年第2期14卷 472-486页

作者： Li, Jing Xing, Zhenchang Kabir, Muhammad Ashad Nanyang Technol Univ Sch Comp Sci & Engn Singapore 639798 Singapore Australian Natl Univ Coll Engn & Comp Sci Canberra ACT 0200 Australia Charles Sturt Univ Sch Comp & Math Barton ACT 2600 Australia

For an unfamiliar Application Programming Interface (API), software developers often access the official documentation to learn its usage, and post questions related to this API on social question and answering (Q&A) sites to seek solutions. The official software documentation often captures the information about functionality and parameters, but lacks detailed descriptions in different usage scenarios. On the contrary, the discussions about APIs on social Q&A sites provide enriching usages. Moreover, existing code search engines and information retrieval systems cannot effectively return relevant software documentation when the issued query does not contain code snippets or API-like terms. In this paper, we present CnCxL2R, a software documentation recommendation strategy incorporating the content of official documentation and the social context on Q&A into a learning-to-rank schema. In the proposed strategy, the content, local context and global context of documentation are considered to select candidate documents. Then four types of features are extracted to learn a ranking model. We conduct a large-scale automatic evaluation on Java documentation recommendation. The results show that CnCxL2R achieves state-of-the-art performance over the eight baseline models. We also compare the CnCxL2R with Google search. The results show that CnCxL2R can recommend more relevant software documentation, and can effectively capture the semantic between the high-level intent in developers' queries and the low-level implementation in software documentation.

关键词： software documentation recommendation systems question and answering sites ranking model

来源：评论

学校读者我要写书评

暂无评论

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

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

请选择保存的检索档案：

请选择收藏分类：

通借通还

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

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

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

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

通借通还

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

请选择保存的检索档案：

请选择收藏分类：