Keycloak

1
= Documentation Style Guide
2

3
== Style Guides to Follow
4

5
. IBM Style Guide (printed)
6
. This document
7

8
Writers will also refer to these:
9
. link:https://www.ibm.com/developerworks/library/styleguidelines/[IBM DeveloperWorks Editorial Style Guide]
10
. link:http://brand.redhat.com/elements/[RH Corporate]
11

12

13
== Style Guidelines
14

15
* Use title case for headings.
16
** Unsure of the proper capitalization? See link:http://titlecase.com/[http://titlecase.com/]  
17
* Write clear, short sentences.
18
* Use definite and indefinite articles like _an_ and _the_.
19
+
20
*Incorrect:* Create project. Delete object from editor. +
21
*Correct:* Create a project. Delete an object from the editor.
22
+
23
* Start steps with an active verb, such as *Enter*, *Edit*, and *Click*.
24
* Start headings with gerunds (verbs that end in -ing), such as *Configuring*, *Creating*, and *Installing*.
25
* Use *bold* for GUI items. Match the capitalization you see in the GUI.
26
* End entries in bulleted and numbered lists with periods when the entries are complete sentences.
27
* Use `$ sudo`, not `#` for superuser terminal commands.
28
* Don't use contractions.
29
+
30
*Incorrect:* Don't use contractions. +
31
*Correct:* Do not use contractions.
32
+
33
* Use `++_italics_++` for emphasis, not `++*bold*++`.
34
* Spell out integers that are less than 10, such as "four", not "4".
35
** Always use numerals in ranges, even when either or both of the numbers are less than 10.
36
* Do not use Latin abbreviations, such as e.g., etc., and i.e.
37
** Instead, use "and so on" when you list a clear sequence of elements, such as "1, 2, 3, and
38
so on". Otherwise, rewrite the sentence to replace etc. with something more descriptive, 
39
such as "and other output".
40
** Instead of i.e. use "that is".
41
** Instead of e.g. use "for example" or "such as".
42
* Do not use "&" in place of "and".
43
* Do not use "and/or".  Pick one.
44
  
45

46
== See Also
47

48
* link:http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc Syntax Quick Reference]
49
* link:screenshots.adoc[Screenshot Guide]
50
* link:terms_conventions.adoc[RH-SSO Terms and Conventions]
51
* link:http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/glossary-of-terms-and-conventions-for-product-documentation-branch-master/lastSuccessfulBuild/artifact/index.html[Red Hat Glossary of Terms and Conventions]
52
* link:https://mojo.redhat.com/docs/DOC-1136272[Red Hat Style Guide and Writers Checklist]