Company
Spectro Cloud style guide
20 rules across 1 topics, naming 78 terms.
- 17 errors
- 2 warnings
- 1 suggestion
- The guide
- spectrocloud.atlassian.net
- Rules from
- spectrocloud/spectro-vale-pkg
- Read at
- e02b05f
- License
- Apache-2.0
The guide, by topic
Select a rule to see what it asks for.
Word choice
20 rules · preferred terms, jargon, and words to avoidableism 18 acronym-no-expand 21 acronym admonitions brand 6 condescending 11 direction 7 file-type 16 future 7 gender 7 heading-all-caps heading-title-case headings-title inclusive 2 longform numbers 6 oxford-comma plural-parantheses product-ui 7 we 4
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| as described before | Avoid it | |
| as mentioned above | Avoid it | |
| as stated above | Avoid it | |
| blind | unaware | |
| clearly | Avoid it | |
| coming soon | Avoid it | |
| common knowledge | Avoid it | |
| common sense | Avoid it | |
| crazy | unbelievable | |
| cripple | impair | |
| csv file | CSV file | |
| dropdown menu | drop-down menu | |
| dumb | unintelligent | |
| earlier in this document | Avoid it | |
| easily | Avoid it | |
| easy | Avoid it | |
| everyone knows | Avoid it | |
| he | they | |
| he/she | they | |
| her | them | |
| him | them | |
| his | their | |
| idiot | foolish | |
| imbecile | foolish | |
| in the future | Avoid it | |
| insane | outrageous | |
| iso file | ISO file | |
| iso image | ISO image | |
| json file | JSON file | |
| jump | proceed | |
| lame | ineffective | |
| let's | Avoid it | |
| mad | furious | |
| md file | Markdown file | |
| moron | thoughtless | |
| nav bar | left main menu | |
| navbar | left main menu | |
| nested nav bar | <Feature> menu | |
| nested navbar | <Feature> menu | |
| next release | Avoid it | |
| not yet available | Avoid it | |
| nuts | ridiculous | |
| obvious | Avoid it | |
| obviously | Avoid it | |
| of course | Avoid it | |
| pdf file | PDF file | |
| png file | PNG file | |
| previously stated | Avoid it | |
| psycho | unstable | |
| py file | Python file | |
| refer to the above | Avoid it | |
| retard | delay | |
| see | display | |
| see above | Avoid it | |
| she | they | |
| simple | Avoid it | |
| simply | Avoid it | |
| slave | Avoid it | |
| spastic | clumsy | |
| spectro cloud | Avoid it |
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