This repository has been archived by the owner on Feb 26, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 18
Style Guide
timothymeyers edited this page Jun 15, 2016
·
1 revision
Adapted from ThoughtWorks (http://style.thoughtworks.com/tone-of-voice/)
- Use active and colourful verbs to breathe life and momentum into your writing and inspire your reader to take action. Avoid passive verbs and "-ing" verbs wherever you can.
- Compare "Understand how it was developed by watching this video." vs "Watch how it was developed."
- Compare "Learn about participating or presenting at the next event." vs "Participate or present at the next event."
- Compare "We use an integrated user experience design and delivery approach." vs "We integrate user experience design and delivery."
- Be conversational. Write as you would speak. Speak like a person.
- Be direct and to the point. Use contractions, short words, and active voice. Reduce syllables. Reduce Latin. Reduce jargon.
- "This is a better way of working together." vs "This framework ameliorates many common concerns in coworking."
- Be enthusiastic. Show excitement and interest in your subject or cause.
- Be thought-provoking. Be disruptive and challenging.
- Don't be confrontational or accusatory, ie "We denounce all those who stand in the way of progress."
- Do challenge the reader to think further about the subject. "We recognize and support those who speak truth to power, expose wrongdoing, and agitate for progress."
- Be edgy. Be new and unusual. Perhaps make people uncomfortable.
Matters of preference, but this is how we will be consistent
- Agile vs. agile. We do not capitalize the ‘A’ when referring to agile the practice. The only exception is for a title such as the “Manifesto for Agile Software Development”. It's definitely not "AGILE" or "Agile Scrum."
- It's Scrum. Not scrum, or SCRUM.
- It's Kanban, with a capital K.
- It's Scrum Master, with a space.
- It's a daily standup; not a daily Scrum.
- It's story point estimation, not "pointing."