: Re: How I should handle gender-neutral pronoun in technical writing? I am writing API documentation for a mobile loyalty program and I am not sure which of the following is better wording: 1) When

@Goswami879

Vote Up Vote Down

Using "he/his" will annoy some of your readers; using singular "they" will annoy others. And referring to a user as "it" will seem weird to most people.
What I do is to write around the problem wherever possible. First off, if you're referring to the user of your API, it's better to write in second person imperative anyway -- "do this, then do that". It's clear, direct, and less convoluted than "descriptive" style ("the user does X and...").
Maybe you're not talking about the reader, though -- your reader is building something (using your API) that will in turn have users, and you need to talk about those users. For example, let's talk about an API that lets your user build an app that somebody else will log into and configure. Here are some examples of ways to talk about that user without using gendered or wrong-number pronouns:

The user creates an account and registers it with your service.
After logging in the user can access a configuration menu to (do something).

I had to work a little to come up with those examples, not because of the writing style but because most of the time your API documentation shouldn't be talking about how your reader's users do something. After all, your reader is responsible for the user interface. You're more likely to write things like this:

When the user logs out, remember to call some_function() to also flush the session data.
Use the register() function to tie a user ID to an OpenID credential.

(0)

Login to post a comment!