Second person and first person

Stay organized with collections Save and categorize content based on your preferences.

In general, use second person in your documents rather than first person—you instead of we. Address the reader as you, and assume that the reader is the person who's doing the tasks that you're documenting. Use the word user only to refer to the user of the software that your reader is developing.

It's also important to figure out who the you is that you're addressing (a developer? a sysadmin? someone else?) and to be consistent about that. Make it clear to the reader who you expect them to be (sometimes with an explicit audience sentence near the beginning of the document).

Example of we versus you:

Recommended: If you're deleting multiple entries at a time ...

Not recommended: If we're deleting multiple entries at a time ...

If you're telling the reader to do something, then use the imperative, with an implicit you. For example:

Recommended: Click Submit.

This issue can also interact with tense:

Recommended: Create an XML entry.

Not recommended: You'll need to create an XML entry.

It's generally best to avoid our.

Recommended: For details, read All About Pandas.

Also recommended: For details, read the documentation.

Not recommended: For details, read our documentation.