Company
Elastic docs style guide
32 rules across 7 topics, naming 313 terms.
- 1 error
- 15 warnings
- 16 suggestions
- The guide
- elastic.co
- Rules from
- elastic/vale-rules
- Read at
- 17f708a
- License
- Apache-2.0
- Used by
- 1 of 355 public configs
The guide, by topic
Select a rule to see what it asks for.
Word choice
19 rules · preferred terms, jargon, and words to avoidArticles 25 British spellings 36 Clone 4 Conflict markers 3 Device agnosticism 3 Dimensions Directional language 42 Dont use 14 End puntuaction Kibana chrome terms 10 Mapped pages Meaningful CT as Menu arrows 2 Menu arrows bold 2 Negations 10 Repetition 2 Spelling Versions 16 Word choice 29
Concision
1 rule · long sentences, filler, and wordy phrasesWordiness 123
Voice and tone
1 rule · person, tense, contractions, and claimsFirst person
Inclusive language
3 rules · gendered, ableist, and loaded termsAccessibility 22 Gender 2 Gender bias 34
Punctuation
5 rules · commas, dashes, quotes, and spacingEllipses Exclamation Oxford comma Quotes punctuation Semicolons
Headings
1 rule · capitalization and punctuation in titlesHeading colons
Abbreviations
2 rules · acronyms, latin, and periodsLatinisms 7 Plural abbreviations
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| a API | an API | |
| a FAQ | an FAQ | |
| a HTML | an HTML | |
| a HTTP | an HTTP | |
| a HTTPS | an HTTPS | |
| a IDE | an IDE | |
| a myriad of | myriad | |
| a RSS | an RSS | |
| a SDK | an SDK | |
| a SQL | an SQL | |
| a SSD | an SSD | |
| a SSH | an SSH | |
| a SSL | an SSL | |
| a SVG | an SVG | |
| a victim of | Avoid it | |
| a XML | an XML | |
| a XSS | an XSS | |
| a.k.a. | Avoid it | |
| able-bodied | Avoid it | |
| abnormal | atypical, not typical | |
| abort | stop, cancel, end | |
| abuse | misuse | |
| acknowledgement | acknowledgment | |
| ad hoc | if needed | |
| ad-hoc | if needed | |
| adversely impact | hurt | |
| aka | Avoid it | |
| all across | across | |
| all of | all | |
| all of a sudden | suddenly | |
| all of these | these | |
| all-time record | record | |
| almost all | most | |
| almost never | seldom | |
| along the lines of | similar to | |
| alumnae | graduates | |
| alumnus | graduate | |
| amongst | among | |
| an adequate number of | enough | |
| an appreciable number of | many | |
| an CPU | a CPU | |
| an CSV | a CSV | |
| an epileptic | Avoid it | |
| an estimated | about | |
| an GPU | a GPU | |
| an GUI | a GUI | |
| an JSON | a JSON | |
| an PDF | a PDF | |
| an RAM | a RAM | |
| an URI | a URI | |
| an URL | a URL | |
| an USB | a USB | |
| analyse | analyze | |
| and higher | and later | |
| and lower | and earlier | |
| and newer | and later | |
| and older | and earlier | |
| and/or | Avoid it | |
| any and all | all | |
| app menu | application menu |
These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.
All 16 guides