grammar - User tutorial: to be written in first or second person?



I'm writing a user tutorial but I'm unsure as to what perspective it should be written from e.g., first, second? The tutorial is a friendly guide showing how the user should do x.


Example:



Viewing your file there are some special instructions you should be familiar with.


Viewing our file there are some special instructions we should be familiar with.


..and refers to the version we want to install.


...and refers to the version you want to install.



Which is correct?



Answer



Having written several user manuals, I can offer the following from experience:




  1. Consistency is very important. It's really easy to accidentally slip into: "The user should click this button. You should see this result." So once the decision is made, stick with it. (As an aside, this is an especially troublesome issue when the user manual is large and written by multiple stakeholders.)




  2. There are three options: first person (usually plural), second person (usually singular), and third person (either singular or plural). There is no "wrong" choice, but there are expectations and opinions that you might want to take into account.




  3. First person places the emphasis on the software creator, rather than the reader. This is usually a bad idea (my opinion), because the reader is interested in how the software will benefit/impact him, not how the software has been shaped by the author. Even using the "royal we" does little to assuage this.




  4. Second person is acceptable, especially for somewhat less formal usage, but the repetition of "you" over and over becomes tiresome. Usually this ends up being simple imperatives ("Click this button"), which are fine for many cases, including a sequence of directions.




  5. Third person is the most formal and (my opinion) the most widely accepted for narrative, particularly formal official documentation. It does, however, get a bit awkward for lengthy step-by-step directions. Singular vs. plural doesn't seem to make much difference, but if the author uses both singular and plural forms in the same section, there should be a good reason for doing so (versus mere accidental inconsistency).




Given the above, my preference is to use third person singular for block text and narrative, and second person singular (imperative) for directions. For example:



The key system functions are available to the user after logging in. In order to perform x, the user must first perform task y. The user can accomplish the task from either the menu bar or the navigation bar, as follows:




  1. Click button n.




  2. Read through the terms and conditions.




  3. Acknowledge the terms and conditions by clicking OK.




  4. Select an option from the navigation menu on the left.





Comments

Popular posts from this blog

verbs - "Baby is creeping" vs. "baby is crawling" in AmE

commas - Does this sentence have too many subjunctives?

grammatical number - Use of lone apostrophe for plural?

etymology - Where does the phrase "doctored" originate?

phrases - Somebody is gonna kiss the donkey

typography - When a dagger is used to indicate a note, must it come after an asterisk?

etymology - Origin of "s--t eating grin"