Skip to content

Commit c142151

Browse files
authored
Merge pull request #370 from mportman12/add-minimalism-principles
added Minimalism section
2 parents 3074e54 + 154a2b5 commit c142151

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.
109+
110+
Minimalism has five principles:
111+
112+
=== Principle 1: 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+
=== Principle 2: Findability
116+
Findability covers two areas:
117+
118+
* Ensure your content is findable through Google search and access.redhat.com site searches.
119+
* Ensure your content is scannable. Use short paragraphs and sentences and bulleted lists where appropriate.
120+
121+
=== Principle 3: Titles and headings
122+
Use clear titles with familiar keywords for customers. Keep titles and headings between 3 to 11 words. Headings that are too short lack clarity and don’t help customers know what’s in a section. Headings that are too long are less visible in Google searches and harder for customers to understand.
123+
124+
=== Principle 4: Elimination of fluff
125+
Avoid long introductions and unnecessary context. Shorten unnecessarily long sentences.
126+
127+
=== Principle 5: 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)