An interview with Joanna Suau from Infobip on the design of application programming interface (API) documentation

Author(s):  
Thomas Bohm

Abstract About Joanna Suau Joanna studied English literature and culture at the University of Silesia in Poland, where she was born. She did a technical writing postgraduate degree in the picturesque city of Krakow and moved to the U.K. in 2012, to work for shipping solutions provider Pierbridge, where she mainly focused on user guides and walkthroughs of various types of shipping applications. Interested in what makes an app tick, Joanna started learning programming language (JavaScript) and explored CSS and HTML in more detail. This is when she discovered her passion for writing clean and appealing developer-oriented documentation, and moved to the start-up company Moltin, to become a part of the Developer Success team. Joanna has changed industry, and currently works in the field of telecommunication. She works for a messaging services provider, Infobip, contributing content to their robust API solutions.

2021 ◽  
Vol 24 (2) ◽  
Author(s):  
George Ajam ◽  
Carlos Rodriguez ◽  
Boualem Benatallah

Application Programming Interface (API) is a core technology that facilitates developers’ productivity by enabling the reuse of software components. Understanding APIs and gaining knowledge about their usage are therefore fundamental needs for developers. Here, API documentation plays a pivotal role in enabling developers to take full advantage of the benefits brought by APIs. The quality of API documentation has therefore become an important concern given the celerity and dynamics at which APIs are now being made available to users. This article aims at exploring existing research in the area of API documentation in order to identify the associated quality dimensions addressed by the literature. The research is carried out as a systematic mapping study where 103 research papers selected from the literature were reviewed and a total of 5 core quality dimensions were identified and analyzed. By focusing on the two most relevant quality dimensions (understandability and completeness), this article presents an approach to enable API users to explore, discover and learn about APIs through API topic issues discussed in Stack Overflow (SO). We demonstrate the feasibility of our approach through Scout-bot, our tool for exploration and discovery of API topic issues.


Compiler ◽  
2021 ◽  
Vol 10 (2) ◽  
pp. 79
Author(s):  
Sudaryanto Sudaryanto ◽  
Anggraini Kusumaningrum ◽  
Yuliani Indrianingsih ◽  
Dadan Rachman Prabowo

Enhanced Interior Gateway Routing Protocol (EIGRP) is a routing protocol that can be used to determine the path of data to be sent. EIGRP can achieve goals and study interconnected networks to obtain useful information to determine the best path. EIGRP is only adopted by Cisco routers or can be called a Cisco Proprietary Protocol, which can only be used on Cisco router devices. Currently, the EIGRP routing configuration uses the command line. For this reason, a Website-based EIGRP system was created and can be accessed remotely (remotely) with the aim of providing freedom of access and not focusing on one device. Website-based EIGRP system was created by utilizing Cisco's API as a liaison between the programming language and Cisco Router 2811 software. Telnet utilization plays a very important role in creating a Website-based EIGRP System where Telnet can provide wider access in management. By visiting the host and port of the router, the EIGRP Website Based System can easily do this. The results of the test in this study indicate that the Website-based EIGRP system is proven to be able to configure, so that administrators can use it for device management of Cisco Router 2811.


2018 ◽  
Vol 4 (2) ◽  
pp. 159
Author(s):  
Edo Halim Saputra ◽  
I Made Arsa Suyadnya ◽  
I Made Oka Widyantara

This research intends to build an application that can be a place for members of the fishing community. The application is built on three main modules: user management, spot fishing management, and discussion management. Applications built using java programming language with android platform this application also uses API (Application Programming Interface) built with PHP programming language as interface processing data to database. Application testing is done by black box method and usability software, with the test result stated that the three main modules are running well and deserve to be used to be a means of information exchange for members of the fishing community.


2021 ◽  
Vol 6 (2) ◽  
pp. 63-72
Author(s):  
Wei Xuan

Providing group study rooms is an important service offered by a university library to support learning and collaboration. A good room booking system should be convenient for students to use and would require a minimum involvement of library staff regarding managing bookings and keys. This article studied the implementation of the Juno Secure Room Booking system at the library to replace LibCal, which is a popular room booking system used by a large number of university libraries in North America. This article discussed the advantages that the Juno system has compared to LibCal, the design of an online booking website using the Juno Application Programming Interface (API), and the enhancement the library designed and developed based on student feedback. This article also discussed how the library successfully engaged a college to use this system to manage study rooms for classes and exams.


2017 ◽  
Vol 48 (3) ◽  
pp. 295-330 ◽  
Author(s):  
Michael Meng ◽  
Stephanie Steinhardt ◽  
Andreas Schubert

The success of an application programming interface (API) crucially depends on how well its documentation meets the information needs of software developers. Previous research suggests that these information needs have not been sufficiently understood. This article presents the results of a series of semistructured interviews and a follow-up questionnaire conducted to explore the learning goals and learning strategies of software developers, the information resources they turn to and the quality criteria they apply to API documentation. Our results show that developers initially try to form a global understanding regarding the overall purpose and main features of an API, but then adopt either a concepts-oriented or a code-oriented learning strategy that API documentation both needs to address. Our results also show that general quality criteria such as completeness and clarity are relevant to API documentation as well. Developing and maintaining API documentation therefore need to involve the expertise of communication professionals.


Author(s):  
I Kadek Owen Nirvana Kaskora ◽  
I Made Sukarsa ◽  
Ni Made Ika Marini Mandenni

Telegram Instant Messaging, launched in August 2013, is an IM application. One of the advantages of telegram is processing instant messages by providing features for the wider community to use the Application Programming Interface. Bot is one of the APIs used in general to run an automatic job on computer programs. The implementation of bots has begun to be widely used. One of the advantages of Bot is that it can provide data that does not manage time to users. Bhagawad Gita and Hindu prayers can be accessed through many media, but not through instant messages. Users should still read books or search on websites to find sloka or prayers. One solution is to use the Telegram chat bot. Users only need to send commands to find information about Hindu sloka or prayers in the chat bot, after which the bot will respond according to the instructions that the user sent. The bot will look for these commands on the database system and send them to the user. PHP programming language or Hypertext PreProcessor with the language framework that will be used in building this system.


2018 ◽  
Vol 9 (1) ◽  
pp. 24-31
Author(s):  
Rudianto Rudianto ◽  
Eko Budi Setiawan

Availability the Application Programming Interface (API) for third-party applications on Android devices provides an opportunity to monitor Android devices with each other. This is used to create an application that can facilitate parents in child supervision through Android devices owned. In this study, some features added to the classification of image content on Android devices related to negative content. In this case, researchers using Clarifai API. The result of this research is to produce a system which has feature, give a report of image file contained in target smartphone and can do deletion on the image file, receive browser history report and can directly visit in the application, receive a report of child location and can be directly contacted via this application. This application works well on the Android Lollipop (API Level 22). Index Terms— Application Programming Interface(API), Monitoring, Negative Content, Children, Parent.


Sign in / Sign up

Export Citation Format

Share Document