Voice and Tone
Last updated
Was this helpful?
Last updated
Was this helpful?
The goal of this wiki is to create a single source of truth for all members on the project, and to get new team members up to speed quickly. It is important that the content not only be accurate and up-to-date, but also sound that way. Write confidently and with authority. What you write now will probably be here forever.
Use short words, short sentences and short paragraphs. This ensures the document is accessible. Use as little jargon as possible.
When you link to external documents, include a short summary of the most important take-aways above the link.
Avoid excessively long sentences which overuse the word “and".
Incorrect: Write with more confidence and learn to project executive tone and find all errors.
Correct: Write with more confidence. Learn to project executive tone. Find all errors.
Follow the as much as possible. Put essential information first, then supporting or explanatory information in order of diminishing importance. Put the least important information at the bottom. Use the different heading types to help create this hierarchy.