In:Information Design Journal
Vol. 26:2 (2021) ► pp.91–104
Miscellaneous
An interview with Joanna Suau from Infobip on the design of application programming interface (API) documentation
Published online: 20 December 2021
https://doi.org/10.1075/idj.00011.boh
https://doi.org/10.1075/idj.00011.boh
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.
References (36)
Allen, I. (2018). The brutal lifecycle of JavaScript frameworks. [URL]
Angular. (2021). Angular is a platform for building mobile and desktop web applications. [URL]
Baker, T. (2011). Every page is page one. [URL]
Barratt, M. [@mark_barratt]. (2009, May 16). OK, all else *has* failed so it’s time to read the documentation [Tweet]. Twitter. [URL]
Bohm, T. (2018). Accessibility and usability in communication design. In S. Heller & V. Veronique (Eds.), Citizen designer (2nd Eds.). Allworth Press.
Bootstrap. (2021). The most popular HTML, CSS, and JS library in world. [URL]
Cherryleaf. (2003). How many technical writers should we have in our organization? [URL]
Diamond, A., Hazell, B., & Stevens, L. (2020, August 27). Content design. [URL]
Ember. (2021). Ember.js – A framework for ambitious web developers. [URL]
Flare. (2021). Flare technical documentation and writing software. [URL]
GitHub. (2021). GitHub docs API. [URL]
Go Programming Language. (2021). Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. [URL]
Hiller, C., Hinton, S., Hussein, A., & Santo, J. (Host). (2020, November 19). How to design a great API [Audio podcast]. JS Party – episode #154. [URL]
Infobip. (2021). Infobip API reference. [URL]
jQuery. (2021). jQuery API documentation. [URL]
Luna, P. (2021). Paul Luna on the typographer’s task [Video]. [URL]
Nielsen, J. (2008). How little do users read? [URL]
Postman. (2021). Postman is an API platform for building and using APIs. [URL]
React. (2021). A JavaScript library for building user interfaces. [URL]
Santos, W. (2019). APIs show faster growth rate in 2019 than previous years. [URL]
Sless, D. (1989, November 26–29). Practical solutions to the interface crisis [Conference presentation]. 25th Annual Conference of the Ergonomics Society of Australia, Canberra, Australia. [URL]
(1990). The theatre of interface. Communication News, 191. [URL]
(2004). Designing public documents. Information Design Journal, 12(1).
(2017). From semiotics to choreography. Information Design Journal, 23(2).
Spiekermann, E. (2016, January 15). Erik Spiekermann – on my Om. Om Malik blog. [URL]
Stripe. (2021). Stripe documentation. [URL]
Suau, J. (2018). Accessibility in online documentation. Communicator, 20181(4, Winter). [URL]
(2020). Support, customer experience and docs. Communicator, 20201(3, Autumn). [URL]
Technical Communication UK Conference. (2021). Website. [URL]
The Institute of Scientific and Technical Communicators. (2021). Website. [URL]
Twilio. (2021). Twilio API reference. [URL]
Vue.js. (2021). The progressive JavaScript framework. [URL]
Waller, R. (1979). Typographic access structures for educational texts. In P. A. Koles, M. E. Wrolstad, & H. Bouma (Eds.), Processing of visible language (Vol. 11). Plenum Press.
(1982). Text as diagram: Using typography to improve access and understanding. In Jonassen, D. H. (Eds.), The technology of text: Principles for structuring, designing and displaying text. Educational Technology Publications.
Whiteside, K. (2018, February 2). How to carry out a plain language edit. [URL]