Skip to content

Commit 154a2b5

Browse files
committed
added numbering
1 parent fb56f95 commit 154a2b5

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

supplementary_style_guide/style_guidelines/grammar.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,22 @@ Minimalism is a methodology for creating targeted documentation focused on your
109109

110110
Minimalism has five principles:
111111

112-
=== Customer focus and action orientation
112+
=== Principle 1: Customer focus and action orientation
113113
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.
114114

115-
=== Findability
115+
=== Principle 2: Findability
116116
Findability covers two areas:
117117

118118
* Ensure your content is findable through Google search and access.redhat.com site searches.
119119
* Ensure your content is scannable. Use short paragraphs and sentences and bulleted lists where appropriate.
120120

121-
=== Titles and headings
121+
=== Principle 3: Titles and headings
122122
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.
123123

124-
=== Elimination of fluff
124+
=== Principle 4: Elimination of fluff
125125
Avoid long introductions and unnecessary context. Shorten unnecessarily long sentences.
126126

127-
=== Error recovery, verification, and troubleshooting
127+
=== Principle 5: Error recovery, verification, and troubleshooting
128128
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.
129129

130130
// TODO: Add new style entries alphabetically in this file

0 commit comments

Comments
 (0)