Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A Present tense in user manuals

Let's break down your illustrative sentence: Users can delete Servers This statement describes a capability -- users can perform this action. I'm hard-pressed to imagine how a different ten...

posted 10y ago by Monica Cellio‭  ·  last activity 5y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T03:24:21Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/10434
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by (deleted user) · 2019-12-08T03:24:21Z (almost 5 years ago)
Let's break down your illustrative sentence:

> Users can delete Servers

This statement describes a capability -- users _can_ perform this action. I'm hard-pressed to imagine how a different tense could be used here. Some technical writers (or style guides) make this overly passive -- "the system supports user deletion of servers" or some such. Speaking from 20+ years of experience in the field I say: don't do that. It's harder to read, harder to translate, and cumbersome without cause.

> that do not have Customers assigned to them.

This looks like a present-tense verb ("do not have"), but its function here is as a _description of state_. What is important is that these servers do not, at the time that a user tries to delete them, have customers. This is perfectly acceptable. You may sometimes see "...that have not had Customers assigned to them" instead;<sup>1</sup> do whatever is consistent with the documentation set your work is part of. (Possibly there's a house style guide that calls this out, but you may just have to read other examples to determine this.) I have only anecdotal evidence here, but I've found that the "present" formation ("do not have") leads to better reader comprehension (measured in requests for help) than the "past" formation ("have not had").

Technical documentation, unlike some other forms of writing, speaks to the reader in the present -- he has a problem to solve and he consults the documentation to find out what to do. Technical documentation is usually imperative ("do X"), and trying to combine the imperative mode with past tense can get confusing. You will still use "past-flavored" phrases like "after you have done X", or "if you have previously done Y", but the main thread of your documentation will make the most sense to readers in an imperative/present style as I've described (and as you've naturally gravitated toward).

(This answer applies to English-language technical writing. I'm not qualified to address other languages.)

* * *

<sup>1</sup> _Technically_ this is not an equivalent statement; if the system allows customers to be assigned and then un-assigned, then a server might _have had customers assigned_ but still _not have customers assigned_ (at the present time). If you're going to use the "past" formation, make sure this does not render your documentation incorrect!

#1: Imported from external source by user avatar System‭ · 2014-03-02T23:28:07Z (over 10 years ago)
Original score: 12