From 30fce84bb696226b4342318630f90f073168751c Mon Sep 17 00:00:00 2001 From: Sean Madsen <sean@seanmadsen.com> Date: Fri, 13 Jan 2017 10:08:00 -0700 Subject: [PATCH] style guide: adding language to avoid dogma. Closes #50 --- docs/best-practices/documentation-style-guide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/best-practices/documentation-style-guide.md b/docs/best-practices/documentation-style-guide.md index b7aa5f11..7bc1fb08 100644 --- a/docs/best-practices/documentation-style-guide.md +++ b/docs/best-practices/documentation-style-guide.md @@ -200,6 +200,13 @@ identify with genders outside of a binary framework. ### Tone and vocabulary +Try to avoid constructions that tell people what they *should* do when multiple +options exists. We want to recognize and respect that there is more than one +way to approach being a user or developer. Preferring constructions that +suggest ways that people can do things. We would like to to avoid language that +gets proscriptive or feels intimidating from a reader's perspective, and we +like having a guide that can be consumed by people in different ways. + **For the *User* and *Administrator* Guides only:** We try and limit the content to tasks that the user can perform from the front end. This means that we don't go into detailed steps about installation or system administration -- GitLab