scholarly journals Automatic API Usage Scenario Documentation from Technical Q&A Sites

2021 ◽  
Vol 30 (3) ◽  
pp. 1-45
Author(s):  
Gias Uddin ◽  
Foutse Khomh ◽  
Chanchal K. Roy

The online technical Q&A site Stack Overflow (SO) is popular among developers to support their coding and diverse development needs. To address shortcomings in API official documentation resources, several research works have thus focused on augmenting official API documentation with insights (e.g., code examples) from SO. The techniques propose to add code examples/insights about APIs into its official documentation. Recently, surveys of software developers find that developers in SO consider the combination of code examples and reviews about APIs as a form of API documentation, and that they consider such a combination to be more useful than official API documentation when the official resources can be incomplete, ambiguous, incorrect, and outdated. Reviews are opinionated sentences with positive/negative sentiments. However, we are aware of no previous research that attempts to automatically produce API documentation from SO by considering both API code examples and reviews. In this article, we present two novel algorithms that can be used to automatically produce API documentation from SO by combining code examples and reviews towards those examples. The first algorithm is called statistical documentation, which shows the distribution of positivity and negativity around the code examples of an API using different metrics (e.g., star ratings). The second algorithm is called concept-based documentation, which clusters similar and conceptually relevant usage scenarios. An API usage scenario contains a code example, a textual description of the underlying task addressed by the code example, and the reviews (i.e., opinions with positive and negative sentiments) from other developers towards the code example. We deployed the algorithms in Opiner, a web-based platform to aggregate information about APIs from online forums. We evaluated the algorithms by mining all Java JSON-based posts in SO and by conducting three user studies based on produced documentation from the posts. The first study is a survey, where we asked the participants to compare our proposed algorithms against a Javadoc-syle documentation format (called as Type-based documentation in Opiner). The participants were asked to compare along four development scenarios (e.g., selection, documentation). The participants preferred our proposed two algorithms over type-based documentation. In our second user study, we asked the participants to complete four coding tasks using Opiner and the API official and informal documentation resources. The participants were more effective and accurate while using Opiner. In a subsequent survey, more than 80% of participants asked the Opiner documentation platform to be integrated into the formal API documentation to complement and improve the API official documentation.

Author(s):  
Gulnara Vorobeva ◽  
Andrei Vorobev

One of the solutions to the problem of spatio-temporal data anisotropy is the use of a multilevel system of digital twins based on the corresponding industry models and the updated archive data base. The application of this approach has successfully proved itself in information systems for monitoring the parameters of the geomagnetic field and its variations, providing spatio-temporal interpolation of geomagnetic data with an accuracy of 0.81 nT in magnetically quiet periods. At the same time, the problem of information interaction between the levels of the system of digital twins remained unresolved, which is greatly aggravated by the constantly growing volume of data and their heterogeneous nature. The paper proposes a solution to the indicated problem by means of a formalized mechanism for packaging space-time information, in which the identification of data sources is performed on the basis of a hierarchical binary tokenization system. In addition, the proposed software implementation of such an approach is considered, a distinctive feature of which is the combination of traditional clientserver and innovative serverless architectures to implement a highly loaded reactive web application for working with analyzed data. The main stages of the implementation of information interaction are highlighted and programmatically formalized - from obtaining initial information from its sources to verifying data, analyzing them, processing and forming the output information flow of the system. The results of the computational experiments carried out on the example of the problem of monitoring the parameters of the Earth's magnetic field and its variations confirmed the effectiveness of the proposed solutions, expressed both in increasing the reactivity of web-based applications and in increasing the computational speed of formation and filling of information storages that aggregate information from distributed heterogeneous sources.


Author(s):  
Wasim A Al-Hamdani

Cryptography has been used since ancient times in many different shapes and forms to protect messages from being intercepted. However, since 1976, cryptography started to be part of protected public communication when e-mail became commonly used by the public. Webmail (or Web-based e-mail) is an e-mail service intended to be primarily accessed via a web browser, as opposed to through an e-mail client, such as Microsoft Outlook, Mozilla‘s Thunderbird Mail. Very popular webmail providers include Gmail, Yahoo! Mail, Hotmail and AOL. Web based email has its advantages, especially for people who travel. Email can be collected by simply visiting a website, negating the need for an email client, or to logon from home. Wherever a public terminal with Internet access exists one can check, sends and receive email quickly and easily. Another advantage of web based email is that it provides an alternate address allowing user to reserve his/her ISP address for personal use. If someone would like to subscribe to a newsletter, enter a drawing, register at a website, participate in chats, or send feedback to a site, a web based email address is the perfect answer. It will keep non-personal mail on a server for you to check when you wish, rather than filling up your private email box. Web service is defined as “a software system designed to support interoperable machine-to-machine interaction over a network”. Web services are frequently just Internet application programming interfaces (API) that can be accessed over a network, such as the Internet, and executed on a remote system hosting the requested services. Other approaches with nearly the same functionality as web services are Object Management Group‘s (OMG) Common Object Request Broker Architecture (CORBA), Microsoft‘s Distributed Component Object Model (DCOM) or SUN‘s Java/Remote Method Invocation (RMI). Integrating Encryption with web service could be performing in many ways such as: XML Encryption and XML Signature. In this article we present client and Web-based E-mail, next generation E-mail and secure E-mail, followed by cryptography in web service and the last part is the future of web service security. The article start with the integration of cryptography with E-mail client and web base then the integration of cryptography and web service is presented. At the end of the major two sections: e-mail service and web service there is a general prospect vision of encryption future for e-mail service and web service. This section presents our view for the cryptography integration with the second generation of e-mail and web service.


Author(s):  
Bonnie Wai-yi Cheuk ◽  
Brenda Dervin

This chapter introduces readers to Dervin’s Sense-Making Methodology (SMM) and demonstrates how it has been applied to design knowledge management projects for the public sector. The projects described in this chapter were implemented between November 2005 to June 2006 when the main author was the Head of Knowledge Management for the Improvement Service for the Scottish Government, a company limited by guarantee with a budget provided by the Scottish Executive, with the aim to improve the efficiency, quality and accountability of public services in Scotland through learning, sharing knowledge and delivering improvement solutions. Sense-Making Methodology is based on a set of assumptions which challenge some fundamental knowledge management thinking. The SMM assumptions imply the need for alternative procedures to be implemented to promote knowledge sharing. Three primary applications are discussed: (a) conducting user study to understand user needs; (b) designing web-based KM systems; and (c) facilitating dialogue to nurture communities of practice. This chapter aims at stimulating further thinking and debate in adopting theoretically informed approaches to implement knowledge management practices.


Accessibility is the possibility of any person to make use of all the benefits of society, including the Internet. As the interfaces are typically graphic, sites can be an obstacle for visually impaired persons to access. For a site to be accessible to blind persons it’s necessary the information contained in the visual resources be reproduced by means of an “equivalent” textual description, capable of transmitting the same information as the visual resources. This study is aimed at identifying and defining usability guidance compliant with accessibility W3C directives that can facilitate the interaction between visually impaired and Internet and still guarantee sites with understandable navigation content. Towards this end an exploratory study was conducted, comprised of a field study and interviews with visually disabled people from Instituto Benjamin Constant, reference center in Brazil for the education of visually impaired persons, in order to get to know these users better.


2011 ◽  
Vol 6 (1) ◽  
pp. 59-73 ◽  
Author(s):  
Teoh Ai Ping

The quality of interaction between learners and online content is one of the imperative factors in determining the efficacy of web-based teaching-learning towards the creation and maintenance of sustainable learning communities. Interaction with content is an internal dialogue of reflective thought that occurs between learner and the substance. Interaction is often triggered and supported by events in the learning environment – focusing on how the learner interacts with what is to be learned. This paper looks at the difference in learners' interaction on the online Learning Management System (LMS) of undergraduate and postgraduate courses. Based on a framework developed for investigating learners' interaction with online content in Wawasan Open University, data from the LMS log and activity database was extracted. The data is then analyzed based on the pattern and behavior of learners' interaction with the online content of the courses. Further analysis is done by transcribing the discussions and exchanges of teacher and learners within the online forums, specifically investigating the dimension, depth and category of exchanges that occurred. Based on the findings, several recommendations are made to enhance the design and delivery of web-based content, aiming at maximizing the efficacy of the online learning environment of undergraduate and postgraduate courses in open distance learning (ODL).


Author(s):  
Aso Mohammed Aladdin ◽  
Chnoor M. Rahman ◽  
Mzhda S. Abdulkarim

In developing web sites there are some rules that developers should depend on in order to create a site suitable to the users’ needs and also to make them as comfort as possible when they surf it. Before creating any website or operating any application, it is important for developers to address the functionality, design, usability and security of the work according to the demands.  Every developer has his/her own way to develop a website, some prefer to use website builders and while others prefer to what they have primarily formed in their mind What they have primarily formed in their mind preferred software and programming languages. Therefore, this paper will compare the web based sites and open source projects in terms of functionality, usability, design and security in order to help academic staffs or business organization for choosing the best way for developing an academic or e-commerce web site.  


10.2196/17247 ◽  
2020 ◽  
Vol 22 (11) ◽  
pp. e17247
Author(s):  
Florent Schäfer ◽  
Carole Faviez ◽  
Paméla Voillot ◽  
Pierre Foulquié ◽  
Matthieu Najm ◽  
...  

Background Gastrointestinal (GI) discomfort is prevalent and known to be associated with impaired quality of life. Real-world information on factors of GI discomfort and solutions used by people is, however, limited. Social media, including online forums, have been considered a new source of information to examine the health of populations in real-life settings. Objective The aims of this retrospective infodemiology study are to identify discussion topics, characterize users, and identify perceived determinants of GI discomfort in web-based messages posted by users of French social media. Methods Messages related to GI discomfort posted between January 2003 and August 2018 were extracted from 14 French-speaking general and specialized publicly available online forums. Extracted messages were cleaned and deidentified. Relevant medical concepts were determined on the basis of the Medical Dictionary for Regulatory Activities and vernacular terms. The identification of discussion topics was carried out by using a correlated topic model on the basis of the latent Dirichlet allocation. A nonsupervised clustering algorithm was applied to cluster forum users according to the reported symptoms of GI discomfort, discussion topics, and activity on online forums. Users’ age and gender were determined by linear regression and application of a support vector machine, respectively, to characterize the identified clusters according to demographic parameters. Perceived factors of GI discomfort were classified by a combined method on the basis of syntactic analysis to identify messages with causality terms and a second topic modeling in a relevant segment of phrases. Results A total of 198,866 messages associated with GI discomfort were included in the analysis corpus after extraction and cleaning. These messages were posted by 36,989 separate web users, most of them being women younger than 40 years. Everyday life, diet, digestion, abdominal pain, impact on the quality of life, and tips to manage stress were among the most discussed topics. Segmentation of users identified 5 clusters corresponding to chronic and acute GI concerns. Diet topic was associated with each cluster, and stress was strongly associated with abdominal pain. Psychological factors, food, and allergens were perceived as the main causes of GI discomfort by web users. Conclusions GI discomfort is actively discussed by web users. This study reveals a complex relationship between food, stress, and GI discomfort. Our approach has shown that identifying web-based discussion topics associated with GI discomfort and its perceived factors is feasible and can serve as a complementary source of real-world evidence for caregivers.


2020 ◽  
Author(s):  
Kaylee Payne Kruzan ◽  
Janis Whitlock ◽  
Natalya N Bazarova

BACKGROUND Many individuals who self-injure seek support and information through online communities and mobile peer-support apps. Although researchers have identified risks and benefits of participation, empirical work linking participation in these web-based spaces to self-injury behaviors and thoughts is limited. OBJECTIVE This study aims to investigate the relationship between behavioral and linguistic traces on a mobile peer support app and self-injury outcomes. METHODS Natural use data and web-based surveys (N=697) assessing self-injury outcomes were collected from 268 users (aged 13-38 years; median 19; 149/268, 55.6% female) of a mobile peer-support app for 4 months. Participants were identified as having posted self-injury content using an internal classifier. Natural log data was used to predict self-injury outcomes in a series of multilevel logistic and linear regressions. RESULTS Greater engagement on a mobile peer-support app was associated with a decreased likelihood of self-injury thoughts (odds ratio [OR] 0.25, 95% CI 0.09-0.73) and fewer intentions to self-injure (<i>b</i>=−0.37, SE 0.09), whereas posting triggering content was associated with an increased likelihood of engaging in behaviors (OR 5.37, 95% CI 1.25-23.05) and having self-injury thoughts (OR 17.87, 95% CI 1.64-194.15). Moreover, viewing triggering content was related to both a greater ability to resist (<i>b</i>=1.39, SE 0.66) and a greater intention to self-injure (<i>b</i>=1.50, SE 0.06). CONCLUSIONS To our knowledge, this is the first study to connect naturally occurring log data to survey data assessing self-injury outcomes over time. This work provides empirical support for the relationship between participation in online forums and self-injury outcomes, and it articulates mechanisms contributing to this relationship. CLINICALTRIAL


10.2196/12555 ◽  
2019 ◽  
Vol 6 (4) ◽  
pp. e12555 ◽  
Author(s):  
Duncan McCaig ◽  
Mark T Elliott ◽  
Cynthia SQ Siew ◽  
Lukasz Walasek ◽  
Caroline Meyer

Background Understanding the characteristics of commenters on mental health–related online forums is vital for the development of effective psychological interventions in these communities. The way in which commenters interact can enhance our understanding of their characteristics. Objective Using eating disorder–related (EDR) forums as an example, this study detailed a methodology that aimed to determine subtypes of mental health–related forums and profile their commenters based on the other forums to which they contributed. Methods The researchers identified all public EDR forums (with ≥500 contributing commenters between March 2017 and February 2018) on a large Web-based discussion platform (Reddit). A mixed-methods approach comprising network analysis with community detection, text mining, and manual review identified subtypes of EDR forums. For each subtype, another network analysis with community detection was conducted using the EDR forum commenter overlap between 50 forums on which the commenters also commented. The topics of forums in each detected community were then manually reviewed to identify the shared interests of each subtype of EDR forum commenters. Results Six subtypes of EDR forums were identified, to which 14,024 commenters had contributed. The results focus on 2 subtypes—proeating disorder and thinspiration—and communities of commenters within both subtypes. Within the proeating disorder subtype, 3 communities of commenters were detected that related to the body and eating, mental health, and women, appearance, and mixed topics. With regard to the thinspiration group, 78.17% (849/1086) of commenters had also commented on pornographic forums and 16.66% (181/1086) had contributed to proeating disorder forums. Conclusions The article exemplifies a methodology that provides insight into subtypes of mental health–related forums and the characteristics of their commenters. The findings have implications for future research and Web-based psychological interventions. With the publicly available data and code provided, researchers can easily reproduce the analyses or utilize the methodology to investigate other mental health–related forums.


2020 ◽  
Vol 5 (2) ◽  
pp. 53-58
Author(s):  
Wina Permana Sari ◽  
Hanugra Aulia Sidharta

Ministry of Health (DepKes) of the Republic of Indonesia, the main problem which is an obstacle for fishermen in a small business in the field of fisheries as a matter of capital. Capital problems that can be reported according to: difficulty in accessing, capital requirements for convoluted capital, to the public ignorance of the relevant institutions. Diverting, taking a few people who then use independent capital, or make loans through informal financial institutions. The problems encountered by the fishermen make them confused and difficult to find when they need the micro business. However, this certainly can be overcome, considering how technology has developed rapidly now. In terms of technological developments, we have now switched to the era of the industrial revolution 4.0, while information and information technology has been highly developed. Seeing the facts that exist in society, technology can be used to facilitate humans in carrying out daily activities. Therefore, in view of the facts above, the writer wants to make a fisheries investment application for investors to invest the capital they need for micro-fisheries businesses and vice versa. The purpose of this research is to create a mobile and web-based Fisheries Investment application (using bootstrap) which the writer will name "Fish" taken from a fisheries investment developed using stages appropriate to the Agile Scrum method based on knowledge within in the field of Software Engineering and is equipped with basic planning models for formation systems, such as: Business Model Canvas (BMC), Use Cases, Activity Diagrams, and Mock-Ups. The results of this study can be used to help organize the distribution of prototype development scenarios to completion with a time schedule.


Sign in / Sign up

Export Citation Format

Share Document