Context before action - Revision history

Max at 23:11, 15 March 2026

2026-03-15T23:11:39Z

← Older revision		Revision as of 19:11, 15 March 2026
Line 36:		Line 36:

	== References ==		== References ==
	<sup>1</sup> Dana E. Chisnell, [https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7519.pdf Style Guide for Voting System Documentation], August 2008, National Institute of Standards and Technology (NIST). ~~Page 84: What is technical communication?~~		<sup>1</sup> Dana E. Chisnell, [https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7519.pdf Style Guide for Voting System Documentation], August 2008, National Institute of Standards and Technology (NIST).

	----		----

	[[Category: Information & Tech]] [[Category: Technical Documentation]]		[[Category: Information & Tech]] [[Category: Technical Documentation]]

Max: Added a link to the front-loading page

2026-03-15T23:04:03Z

Added a link to the front-loading page

← Older revision		Revision as of 19:04, 15 March 2026
Line 4:		Line 4:
	* '''Action before result''' ensures information is presented in the order the user will experience it.		* '''Action before result''' ensures information is presented in the order the user will experience it.

	When a reader starts an action before they realize they're in the wrong place or don't have the right tools, this is called "instructional blindness." In UX writing this is referred to as "front-loading."		When a reader starts an action before they realize they're in the wrong place or don't have the right tools, this is called "instructional blindness." In UX writing this is referred to as "[[Lead with the important details\|front-loading]]."

	== Examples ==		== Examples ==
Line 23:		Line 23:
	== Technical communication research shows... ==		== Technical communication research shows... ==

	Research into technical communication provides reasons why this ordering is critical<sup>1</sup>:		Research into technical communication provides reasons why this ordering is critical:<sup>1</sup>
	* '''Act-first instinct:''' People tend to act as soon as they see words describing an action. If the context/caution is placed at the end, users often perform the action before they reach that information.		* '''Act-first instinct:''' People tend to act as soon as they see words describing an action. If the context/caution is placed at the end, users often perform the action before they reach that information.
	* '''Sense-making:''' When interacting with a new system, users both need to act to understand the program, but also need to understand the program before they can act. Because of this, they'll choose the "first reasonable action" rather than reading all of the instructions first.		* '''Sense-making:''' When interacting with a new system, users both need to act to understand the program, but also need to understand the program before they can act. Because of this, they'll choose the "first reasonable action" rather than reading all of the instructions first.

Max: added Technical Documentation category

2026-03-15T22:52:07Z

added Technical Documentation category

← Older revision		Revision as of 18:52, 15 March 2026
Line 40:		Line 40:
	----		----

	[[Category: Information & Tech]]		[[Category: Information & Tech]] [[Category: Technical Documentation]]

Max: Continued adding context (references did not work, apparently I need a plugin)

2026-03-15T22:50:05Z

Continued adding context (references did not work, apparently I need a plugin)

← Older revision		Revision as of 18:50, 15 March 2026
Line 23:		Line 23:
	== Technical communication research shows... ==		== Technical communication research shows... ==

	Research into technical communication provides reasons why this ordering is critical:		Research into technical communication provides reasons why this ordering is critical<sup>1</sup>:
	* '''Act-first instinct:''' People tend to act as soon as they see words describing an action. If the context/caution is placed at the end, users often perform the action before they reach that information.		* '''Act-first instinct:''' People tend to act as soon as they see words describing an action. If the context/caution is placed at the end, users often perform the action before they reach that information.
			* '''Sense-making:''' When interacting with a new system, users both need to act to understand the program, but also need to understand the program before they can act. Because of this, they'll choose the "first reasonable action" rather than reading all of the instructions first.
	~~<ref>Dana E. Chisnell~~, ~~Style Guide for Voting System Documentation~~, ~~August 2008~~, ~~National Institute~~ of ~~Standards~~ and ~~Technology (NIST)</ref>~~		* '''Constructing mental models:''' A 1987 study found that when context is provided first, readers followed directions more successfully.
			* '''Cognitive load and memory:''' Working memory is limited in how much information it can process simultaneously. Placing the context before the action minimizes cognitive load and allows the reader to immediately orient themselves before their memory is taxed with the procedure steps.

	== Links ==		== Links ==
Line 34:		Line 34:
	* [https://builtin.com/articles/effective-ux-writing 16 Rules of Effective UX Writing]		* [https://builtin.com/articles/effective-ux-writing 16 Rules of Effective UX Writing]
	* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/ Technical Writing Essentials: Writing Instructions]		* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/ Technical Writing Essentials: Writing Instructions]
	* [https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7519.pdf Style Guide for Voting System Documentation, Page 84: What is technical communication?]

	== References ==		== References ==
	‎<~~references~~ />		<sup>1</sup> Dana E. Chisnell, [https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7519.pdf Style Guide for Voting System Documentation], August 2008, National Institute of Standards and Technology (NIST). Page 84: What is technical communication?

	----		----

	[[Category: Information & Tech]]		[[Category: Information & Tech]]

Max: Updated to provide more context about this - publishing early to see if references work?

2026-03-15T22:43:22Z

Updated to provide more context about this - publishing early to see if references work?

← Older revision		Revision as of 18:43, 15 March 2026
Line 1:		Line 1:
	Ordering concepts appropriately in instructions so the reader ~~can follow~~		In technical writing, '''"context before action"''' or '''"action before result"''' are fundamental principles for structuring instructions to match how the human brain processes information. Ordering concepts appropriately in instructions ensures the reader does not take premature/incorrect actions before they fully understand the conditions or consequences. ''It is not appropriate to assume that all users are fully reading the instructions before taking action.''

	~~This is called "Action Before Result"~~ or ~~"Context Before~~ Action~~" and prevents "instructional blindness" (when a reader starts an action~~ before ~~they realize they are~~ in the ~~wrong place or don't have~~ the ~~right tools). In UX writing this is called "front-loading~~."		* '''Context before action''' refers to placing conditions, locations, or requirements before the instruction.
			* '''Action before result''' ensures information is presented in the order the user will experience it.

	Details should be mapped based on how the user will perform them. Include ~~prereqs~~ first, and make no assumptions.		When a reader starts an action before they realize they're in the wrong place or don't have the right tools, this is called "instructional blindness." In UX writing this is referred to as "front-loading."

			== Examples ==

			Details should be mapped based on how the user will perform them. '''Include prerequisites first, and make no assumptions.'''
	* Enter the platform, then do the action.		* Enter the platform, then do the action.
	* Don't assume they're already in the platform or know to go there first, even if the guide is about that platform (especially if the guidance includes other platform work)		* Don't assume they're already in the platform or know to go there first, even if the guide is about that platform (especially if the guidance includes other platform work).
	* If there are many prereqs, include them as a section before the instructions - ensure the reader has the right platform, permissions, and tools before they even begin		* If there are many prereqs, include them as a section before the instructions to ensure the reader has the right platform, permissions, and tools before they even begin.

	Place the goal/context first, then the details after that.		Place the goal/context first, then the details after that.
Line 16:		Line 21:
	* In the first scenario, the non-admin user may have already clicked submit before realizing it doesn't apply to them.		* In the first scenario, the non-admin user may have already clicked submit before realizing it doesn't apply to them.

	Links~~/references~~		== Technical communication research shows... ==
	* [https://learn.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions]
	* [https://developers.google.com/style/procedures]		Research into technical communication provides reasons why this ordering is critical:
	* [https://builtin.com/articles/effective-ux-writing]		* '''Act-first instinct:''' People tend to act as soon as they see words describing an action. If the context/caution is placed at the end, users often perform the action before they reach that information.
	* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/]
			<ref>Dana E. Chisnell, Style Guide for Voting System Documentation, August 2008, National Institute of Standards and Technology (NIST)</ref>


			== Links ==
			* [https://learn.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions Microsoft style guide: Writing step-by-step instructions]
			* [https://developers.google.com/style/procedures Google developer documentation style guide: Procedures]
			* [https://builtin.com/articles/effective-ux-writing 16 Rules of Effective UX Writing]
			* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/ Technical Writing Essentials: Writing Instructions]
			* [https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7519.pdf Style Guide for Voting System Documentation, Page 84: What is technical communication?]

			== References ==
			‎<references />

	----		----

	[[Category: Information & Tech]]		[[Category: Information & Tech]]

Max: added category

2026-03-10T20:22:18Z

added category

← Older revision		Revision as of 16:22, 10 March 2026
Line 21:		Line 21:
	* [https://builtin.com/articles/effective-ux-writing]		* [https://builtin.com/articles/effective-ux-writing]
	* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/]		* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/]

			----

			[[Category: Information & Tech]]

Max: Protected "Context before action" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]

2026-03-10T06:23:56Z

Protected "Context before action" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]

← Older revision	Revision as of 02:23, 10 March 2026
(No difference)

Max: moved from booknotes

2026-03-10T06:23:40Z

moved from booknotes

New page

Ordering concepts appropriately in instructions so the reader can follow

This is called "Action Before Result" or "Context Before Action" and prevents "instructional blindness" (when a reader starts an action before they realize they are in the wrong place or don't have the right tools). In UX writing this is called "front-loading."

Details should be mapped based on how the user will perform them. Include prereqs first, and make no assumptions.
* Enter the platform, then do the action.
* Don't assume they're already in the platform or know to go there first, even if the guide is about that platform (especially if the guidance includes other platform work)
* If there are many prereqs, include them as a section before the instructions - ensure the reader has the right platform, permissions, and tools before they even begin

Place the goal/context first, then the details after that.
* (bad) Do this to do that.
* (good) To do that, do this.

You should tell the reader where an action should take place (or the conditions, objectives) before describing the action to take - where before what, who before what, etc.
* "Click submit if you are an admin" vs "if you are an admin, click submit"
* In the first scenario, the non-admin user may have already clicked submit before realizing it doesn't apply to them.

Links/references
* [https://learn.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions]
* [https://developers.google.com/style/procedures]
* [https://builtin.com/articles/effective-ux-writing]
* [https://pressbooks.bccampus.ca/technicalwriting/chapter/writinginstructions/]