5 ms·
How developers use API documentation: an observation study [pdf]
- telotortium 7y agoMods: please add "How" back to the front - it's needed for the sentence to make sense.
- dang 7y agoYes. Done.
- telotortium 7y agoThanks
- gkoberger 7y agoI feel like this is a bit light on data, since it's only 11 people from 3 companies using 1 (non-English) website. The takeaway, though, is consistent with what I've seen... people like code examples! Most people will scan until they see one, and start there. The heavy focus on API Reference in this study makes me think either the tasks were too specific, or the tutorials weren't comprehensive enough. For a good documentation site, most use cases should be covered by topical guides. Going to the reference guides to learn an API is like reading a dictionary to learn English. There's not a lot of context.
- kaycebasques 7y ago> Going to the reference guides to learn an API is like reading a dictionary to learn English. That doesn't necessarily have to be the case. Back when I was at an IoT startup I structured the reference docs based on the order that a developer would typically use in order to get common tasks done. E.g. call this method to get the device's identifier, and then here's a list of methods that let you do stuff with the device. Chris Bush presented a similar idea [1] at this year's Write The Docs conference. His main argument is that the organization of reference docs is usually implementer-oriented. E.g. alphabetical. In many cases it may make more sense to have a user-oriented organization, one way or another. [1] https://youtu.be/4OtdFEp88VI https://youtu.be/4OtdFEp88VI
- gridlockd 7y ago> His main argument is that the organization of reference docs is usually implementer-oriented. This is absolutely the biggest (and easiest) mistake people make when designing APIs. Force developers to use their own APIs as end-users - quality will improve significantly.
- Crinus 7y agoThis reminds me of the Autotools duality: most developers hate autotools because of its unnecessary complexity but users (ie. those who want to compile the source) like it because of its flexibility (most autotool-based projects build pretty much on anything that smells like Unix), configurability and use of standard tools (shell, make) that are already installed (pretty much every other build system - like cmake, premake, meson, scons, etc - need itself installed on the user's system). So you get developers hating it and users (especially admins and distro packagers) loving it (well, packagers who have to build a lot of stuff sometimes dislike the performance).
- AstralStorm 7y agoUnfortunately, there's not just one autotools but at least two major variants: libtool and direct, with 3 common incompatible versions in the wild: 2.1, 2.6, 2.13. Packagers have some trouble getting fixes to these build systems to stick. Cue Gentoo autotools.eclass with automatic application of generic set of fixes for all the brokenness of the ages.
- Crinus 7y agoAFAIK this is a problem only if you want to regenerate the configure scripts. As a "user" (and packager) you should use the pregenerated configure script provided in the release.
- ekimekim 7y agoThe examples also do the important job of filling in gaps that the reference docs may accidentially leave - one common one for http APIs I've found is how non-string query params are encoded (eg. this value is a list: do I give it multiple times? Do I comma-separate? Or worse: is this enum value a string or an integer?). What's especially fun is when the "code examples" for a http API use a client library which hides the actual http API, so they aren't examples of using the API at all...
- noir_lord 7y agoI’ve never understood why more apis don’t hyperlink they their code samples. It would massively improve discoverability. That and give a single large actual example of interacting with the API. That said I’ve always preferred reading code using a library over reading docs for the same library.
- hv42 7y ago> Going to the reference guides to learn an API is like reading a dictionary to learn English. There's not a lot of context. Exactly! Examples are usually the most useful thing in the documentation. Based on my experience, people go first to the examples and then read the description. I guess that's also why stackoverflow is working so well as it is basically a large library of examples.
- kaycebasques 7y agoI write the Chrome DevTools docs. "Empathy" is a buzzword in technical writing. Recently I wrote a post [1] imploring technical writers to start recording themselves as they use documentation. I want to ask you all to consider doing the same and sending me the footage. My main argument is that the best way to actually develop empathy is to watch lots and lots of people actually use documentation to get stuff done. I've already learned a lot just by watching the videos [2] of me build an Angular app. [1] https://kayce.basqu.es/blog/empathy https://kayce.basqu.es/blog/empathy [2] https://www.youtube.com/playlist?list=PL6UItmiYqJhMr_uYG2DkVNW3oUKbLnNJJ https://www.youtube.com/playlist?list=PL6UItmiYqJhMr_uYG2DkV...
- ben509 7y ago> "Empathy" is a buzzword in technical writing. We should use a term that is more clinical in technical writing. The "empathy" we're aiming for is fully understanding the user experience. That is a correct use of the word, but the popular usage is closer to "sympathy," and often people are using it to indicate they care about treating people well in a broader moral sense. (E.g. "do unto others" is morally empathetic.) The difference is that being empathetic morally is an end in itself, whereas being empathetic technically is a means to an end. Dark UI patterns, for example, are very empathetic in the technical sense in that they use understanding of the user to manipulate them.
- cheez 7y ago"I have a problem, ok I will go to the docs and use the search function to find things that may solve the problem" I can't imagine anyone else does anything but this aside from initial foray into a API
- kccqzy 7y agoOver-reliance on search may be a sign that you are unfamiliar with the general patterns and background knowledge of how this API is supposed to be used. It is a shortcut, a very useful shortcut nonetheless but it definitely shouldn't be the only way to do things.
- yomly 7y agoIt took me a bit of time to get used to them but I am really starting to love the vim docs - I love that I can :help split and then get loads of info of all the possible things I can do with a split for example
- Haga 7y agoAPI documentation is a fallback, once the primary documentation of function names, comments and variablenames fails. In a ideal case I do never use the documentation, I just integrate the api functions and they behave as expected by code samples.