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

83%
+8 −0
Q&A Is there any benefit when writing out instructions to split it up into lots of little paragraphs, or is it better to leave it in one paragraph?

Writing in fuller paragraphs feels like it creates better reading flow, as opposed to short choppy chunks of text, but that's a prose consideration. For instructions, the primary goal is to help t...

posted 4y ago by Monica Cellio‭

Answer
#1: Initial revision by user avatar Monica Cellio‭ · 2020-09-10T14:52:30Z (over 4 years ago)
Writing in fuller paragraphs feels like it creates better reading flow, as opposed to short choppy chunks of text, but that's a *prose* consideration.  For *instructions*, the primary goal is to help the reader do all the necessary steps in applicable order.  If lots of steps are combined in a single paragraph, there is greater risk of the reader missing a part.

In many style guides, procedures are even spelled out as numbered lists.  The reader can then track progress through the list more easily.  This can be overkill if there are only a couple steps but important if there are many, so use your judgement.

Whether you present it as paragraphs or list items, keep it to one logical chunk of work per chunk of text.  A chunk of work might combine several elements -- "fill out your shipping and credit-card information in the form", for example, as opposed to spelling out the individual steps.  Think about the logical chunks from the user's point of view, including how the UI guides the user.

For non-technical examples, consider recipes.  You've probably seen a bunch.  Which style is easier to follow when you're actually cooking, as opposed to when you're browsing cookbooks trying to decide what sounds good for dinner?