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

References

1. Allen, I.
   (2018) The brutal lifecycle of JavaScript frameworks. https://stackoverflow.blog/2018/01/11/brutal-lifecycle-javascript-frameworks/
   [Google Scholar]
2. Angular
   Angular (2021) Angular is a platform for building mobile and desktop web applications. https://angular.io
   [Google Scholar]
3. Baker, T.
   (2011) Every page is page one. https://everypageispageone.com/2011/03/15/every-page-is-page-one/
   [Google Scholar]
4. Barratt, M.
   [@mark_barratt] (2009, May16). OK, all else *has* failed so it’s time to read the documentation [Tweet]. Twitter. https://twitter.com/mark_barratt/status/1815895445
   [Google Scholar]
5. Bohm, T.
   (2018) Accessibility and usability in communication design. InS. Heller & V. Veronique (Eds.), Citizen designer (2nd Eds.). Allworth Press.
   [Google Scholar]
6. Bootstrap
   Bootstrap (2021) The most popular HTML, CSS, and JS library in world. https://getbootstrap.com
   [Google Scholar]
7. Cherryleaf
   Cherryleaf (2003) How many technical writers should we have in our organization?https://www.cherryleaf.com/PDFs/How%20many%20technical%20writers%20should%20we%20have%20in%20our%20organisation.pdf
   [Google Scholar]
8. Diamond, A., Hazell, B., & Stevens, L.
   (2020, August27). Content design. https://gds.blog.gov.uk/2020/08/27/podcast-content-design/
   [Google Scholar]
9. Ember
   Ember (2021) Ember.js – A framework for ambitious web developers. https://emberjs.com
   [Google Scholar]
10. Flare
    Flare (2021) Flare technical documentation and writing software. https://www.madcapsoftware.com/products/flare/
    [Google Scholar]
11. GitHub
    GitHub (2021) GitHub docs API. https://docs.github.com/en
    [Google Scholar]
12. Go Programming Language
    Go Programming Language (2021) Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. https://golang.org
    [Google Scholar]
13. Hiller, C., Hinton, S., Hussein, A., & Santo, J.
    (Host) (2020, November19). How to design a greatAPI [Audio podcast]. JS Party – episode #154. https://changelog.com/jsparty/154
    [Google Scholar]
14. Infobip
    Infobip (2021) Infobip API reference. https://www.infobip.com/docs/api
    [Google Scholar]
15. jQuery
    jQuery (2021) jQuery API documentation. https://api.jquery.com
    [Google Scholar]
16. Luna, P.
    (2021) Paul Luna on the typographer’s task [Video]. https://www.podularity.com/thehedgehogandthefox/2021/10/28/paul-luna-on-the-typographers-task-video/
    [Google Scholar]
17. Nielsen, J.
    (2008) How little do users read?https://www.nngroup.com/articles/how-little-do-users-read/
    [Google Scholar]
18. Postman
    Postman (2021) Postman is an API platform for building and using APIs. https://www.postman.com
    [Google Scholar]
19. React
    React (2021) A JavaScript library for building user interfaces. https://reactjs.org
    [Google Scholar]
20. Santos, W.
    (2019) APIs show faster growth rate in 2019 than previous years. https://www.programmableweb.com/news/apis-show-faster-growth-rate-2019-previous-years/research/2019/07/17
    [Google Scholar]
21. Schriver, K.
    (1997) Dynamics in document design: Creating text for readers. New York: Wiley.
    [Google Scholar]
22. Sless, D.
    (1989, November26–29). Practical solutions to the interface crisis [Conference presentation]. 25th Annual Conference of the Ergonomics Society of Australia, Canberra, Australia. https://www.communication.org.au
    [Google Scholar]
23. Sless, D.
    (1990) The theatre of interface. Communication News, 19. https://www.communication.org.au
    [Google Scholar]
24. Sless, D.
    (2004) Designing public documents. Information Design Journal, 12(1). 10.1075/idjdd.12.1.04sle
    https://doi.org/10.1075/idjdd.12.1.04sle [Google Scholar]
25. Sless, D.
    (2017) From semiotics to choreography. Information Design Journal, 23(2). 10.1075/idj.23.2.06sle
    https://doi.org/10.1075/idj.23.2.06sle [Google Scholar]
26. Spiekermann, E.
    (2016, January15). Erik Spiekermann – on my Om. Om Malik blog. https://om.co/2016/01/15/erik-spiekermann/
    [Google Scholar]
27. Stripe
    Stripe (2021) Stripe documentation. https://stripe.com/docs
    [Google Scholar]
28. Suau, J.
    (2018) Accessibility in online documentation. Communicator, 2018(4, Winter). https://jsuau.github.io/assets/files/Online-accessibility.PDF
    [Google Scholar]
29. Suau, J.
    (2020) Support, customer experience and docs. Communicator, 2020(3, Autumn). https://jsuau.github.io/assets/files/Comm2009Web_JS.PDF
    [Google Scholar]
30. Technical Communication UK Conference
    Technical Communication UK Conference (2021) Website. technicalcommunicationuk.com
    [Google Scholar]
31. The Institute of Scientific and Technical Communicators
    The Institute of Scientific and Technical Communicators (2021) Website. https://istc.org.uk
    [Google Scholar]
32. Twilio
    Twilio (2021) Twilio API reference. https://www.twilio.com/docs/api
    [Google Scholar]
33. Vue.js
    Vue.js (2021) The progressive JavaScript framework. https://vuejs.org
    [Google Scholar]
34. Waller, R.
    (1979) Typographic access structures for educational texts. InP. A. Koles, M. E. Wrolstad, & H. Bouma (Eds.), Processing of visible language (Vol.1). Plenum Press. 10.1007/978‑1‑4684‑0994‑9_11
    https://doi.org/10.1007/978-1-4684-0994-9_11 [Google Scholar]
35. Waller, R.
    (1982) Text as diagram: Using typography to improve access and understanding. InJonassen, D. H. (Eds.), The technology of text: Principles for structuring, designing and displaying text. Educational Technology Publications.
    [Google Scholar]
36. Whiteside, K.
    (2018, February2). How to carry out a plain language edit. www.keyadvice.net/key-blog/how-to-carry-out-a-plain-language-edit
    [Google Scholar]