Skip to content

Commit 6fe3a27

Browse files
committed
added Minimalism section
1 parent 08738e4 commit 6fe3a27

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

supplementary_style_guide/style_guidelines/grammar.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,28 @@ The following list includes homographs that might commonly appear in technical d
103103
* object
104104
* project
105105

106+
[[minimalism]]
107+
== Minimalism
108+
Minimalism is a methodology for creating targeted documentation focused on your readers' needs. If you understand your customers' needs, you can write shorter and simpler documentation specific to what customers want to do. For more information about minimalism, see link:https://source.redhat.com/groups/public/minimalism-quality-initiative[Minimalism in Red Hat documentation].
109+
110+
There are five principles of minimalism:
111+
112+
=== Customer focus and action orientation
113+
Know what your users do, what their goals are, and why they perform these actions. Minimize how much content customers must wade through to get to something they recognize as real work. Separate conceptual and background information from procedural tasks.
114+
115+
=== Findability
116+
Findability covers two areas:
117+
118+
* Make sure your content is findable through Google search and access.redhat.com site searches.
119+
* Make sure your content is scannable. Use short paragraphs and sentences and bulleted lists where appropriate.
120+
121+
=== Titles and headings
122+
Have clear titles that use keywords the customer knows. Keep titles and headings to 3-11 words. If headings are too short, they don’t help customers know what’s in a section. If they’re too long, they don’t show up well in a Google search, and customers can’t absorb them.
123+
124+
=== Eliminating fluff
125+
Avoid long introductions and unnecessary context. Shorten unnecessarily long sentences.
126+
127+
=== Error recovery, verification, and troubleshooting
128+
Recognize that people make mistakes and need to verify that they have completed a task. Be sure to include troubleshooting, error recovery, and verification steps.
129+
106130
// TODO: Add new style entries alphabetically in this file

0 commit comments

Comments
 (0)