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

Commit

Permalink
incorporate feedback from Aidan
Browse files Browse the repository at this point in the history
  • Loading branch information
Cameron Shorter committed Feb 28, 2021
1 parent 2d0a9d8 commit ddcdae8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion base-template/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What's in the base-template directory

This base-template directory contains templates and guides to be followed by a `doctype` template author. They can also be used by a project's docset owner select and customize the project's templates.
This base-template directory contains templates and guides to be followed by a `doctype` template author. They can also be used by a project's docset owner to select and customize the project's templates.

**Version:** 0.1

Expand Down
2 changes: 1 addition & 1 deletion base-template/base-doctype-guide-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ _{TBD: We should link to a page we are yet to write helping people pick personas
* Discuss what format will best express the nature of the content. For example, text only, or multi-media options such as diagrams, screenshots or video.
* Discuss how the format you choose will impact maintenance. This can include human work-hours, as well as ongoing processes and infrastructure requirements.
* Reference your style guide, which should have recommended guidelines for using multimedia, such as image size and video length.
* For content with numerous items or 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 within [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/).
* For content with numerous items or 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 Microsoft in its [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/).

}

Expand Down

0 comments on commit ddcdae8

Please sign in to comment.