Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Merge pull request #187 from thegooddocsproject/aidanatwork-templates…
Browse files Browse the repository at this point in the history
…-issue-68-fix

Update writing-tips.md
  • Loading branch information
barbaricyawps authored Jan 21, 2022
2 parents c668555 + 7c5db57 commit 7450e8c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion writing-tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Follow these writing guidelines when developing content using the templates avai

Here are some recommendations you can use when creating procedural steps:

* Usability studies show that procedures should not be more than seven primary steps long.
* For procedures with numerous steps, consider "chunking" content into sub-sections of 5-10 steps. It makes the information easier to read and remember, and gives the reader a sense of accomplishment after each chunk is completed. Chunking is recommended by major companies, such as in [Microsoft's writing style guide](https://docs.microsoft.com/en-us/style-guide/procedures-instructions/writing-step-by-step-instructions#complex-procedures), and from the Nielsen Norman Group's [research on chunking and usability](https://www.nngroup.com/articles/short-term-memory-and-web-usability/).
* Each step is a single sentence (you should be able to read it aloud, and it should make grammatical sense).
* When describing a step, include a lead-in sentence to remind the reader what they will be doing when following the sub-steps.
* Aim for no more than four sub-steps in any primary step.
Expand Down

0 comments on commit 7450e8c

Please sign in to comment.