29 Sep What MSTP Says
What MSTP Says
— Ruchira Joshi
Rules defined by MSTP for technical documentation.
(Disclaimer! Always use your company’s house style guide if available)
- While writing for accessibility, always use a people-first language approach rather than an identity-first. However, in some cases, people prefer mentioning their disability first so know your audience preferences before writing content.
Click for details. - Use flick to describe scroll action on mobile or tabs. Don’t use scroll for the mobile app.
For example, Flick through the screen to view all available options.
Click for details.
- Use spell checker as a general term for a tool that checks spelling, and to mention a specific tool, use the name of that tool.
For example, use a spell checker to determine correct spelling or use the error-free tool to check spelling.
Click for details.
- Don’t use a colon in the UI while introducing buttons.
Click for details. - Abbreviate simple sequences by using right-angle brackets. Include a space before and after each bracket, and don’t make the brackets bold.
For example, Tap Photos > Choose Photo >
Click for details.
“Try things out, be happy to make mistakes, but above all have a go.”
- Charles Dowding
No Comments