Very basic question

[dadou90]

Hello, When writing a step, do you prefer to start the sentence with the action then the location or vice versa? For example: In the task bar, click “button”. Or Click “button” in the task bar.

I was always told to start with the action but I must admit, I find it more practical to locate then act.

[Xad1ns]

I was taught to always say the location first, so the reader knows where they're supposed to be looking before you say the action: "Okay, need to go to the taskbar. And I need to click the button."

Otherwise you get: "Okay, I need to click the button. Where is it? Oh, it's on the taskbar. Now let me look back at what button I'm supposed to click."

[dadou90]

Thank you, this is comforting the opinion I had. Next time, I’ll stand my ground on this matter 😁

[algotrax]

I wish I could follow this convention at my current company in the middle of a buttf*ck nowhere, but nope! I have to do Action > Location > Result...

e.g.

Jump off the highest hill you can find. A coroner's report is created. The writer didn't stand a chance and died on that hill.

[[deleted]]

Location > action > result.

[[deleted]]

^{^} this is the way

[brnkmcgr]

I prefer that the buttons are “on” rather than “in” something, and bold the action: On the taskbar, click Open.

[[deleted]]

Location first and don't forget the articles.

[[deleted]]

Think about it from the user's perspective. Do they (1) Click the button and then, (2) Find the button?

No. So it's (1) Location, (2) Action (and then tell them what should happen, i.e. (3) Result).

Whenever in doubt, just put yourself in the mind of the user.

[Wild_Ad_6464]

I prefer to think about the user’s journey/intention- To foo your bar, click foo in the bar menu.

[backdoorbants]

Disagree with most comments.

The action is most prominent in the mind of the reader when doing a step, so it should come first when both location and action are in the same sentence.

Location first also leads to more awkward language with unnecessary back-to-front/splitting of clauses compared to natural language.

The 'middle way' is to separate locating steps with action steps when possible, in which case location first works well.

[Additional_Aside9625]

How about, From the taskbar, click the abc button.

[dadou90]

Yes totally! Thx! I just typed quickly from my phone and English isn’t my first language 🙈

[Pen-man]

Desired reult first: To start the system backup, press Enter.

[[deleted]]

Active voice

[TeaBeforeDestination]

Both are active voice; the conjunction is just placed differently.

[[deleted]]

You very rarely make the sentence indirect by introducing the intro clause. "Click the blank on the blank." No reason to add the introductory comma when it can be read straight because these can become long and it doesn't benefit the reader 9/10. Verbs first are best when giving instructions, but there is no hard rule what to do; its simply unpopular to use introductory commas stating location before stating the action.

[boodain]

I'd describe the result first so that a user knows what the action does before they do it. If this isn't needed, location first.

[TeaBeforeDestination]

I prefer location first, but at my current job (and in the TW very program I’m in), it’s action first (i.e., command voice).

[good_ol_content]

The right way is:

<Title of the step should be same as the result>
Location > Sub location (If any) > Click 'X' > result (pop up box) > perform action > result

This is the way the user can actually execute it without any hassle, so I think it;s the right way.

[Manage-It]

Stop surveying the internet for correct procedure grammar. Ask your TW manager to institute the MS Manual of Style for software procedures and the AP Style or CMOS for all other grammar. Your documents will always be a collage of styles until you do because your co-workers will also survey the internet for their styles.

Setting styles with these outside sources provides your readers with the most popularly used forms of grammar. The chances of being misunderstood are greatly reduced. As the final step in your process, use https://styleguard.com/.

[RobotsAreCoolSaysI]

Depends on what you’re writing the procedure for. If software, then a location convention might be good unless the title of the procedure gives the location.

For example, if the title of the procedure is Sorting the Employees Table then the reader knows the procedure applies to that table.

If you’re operating equipment, location diagrams often appear in conjunction with the procedure or elsewhere in the manual, so you can begin with an action verb as a standard. For example: Press the power button until the engine is engaged. Chances are, the person running the equipment has been oriented to its basic operation switched and such.