Skip to content

Instantly share code, notes, and snippets.

@evildmp
Created December 5, 2014 09:27
Show Gist options
  • Save evildmp/8b4e82512c490b295d2d to your computer and use it in GitHub Desktop.
Save evildmp/8b4e82512c490b295d2d to your computer and use it in GitHub Desktop.
Rules for using technical words in documentation
------------------------------------------------
There should be one consistent way of rendering any technical word. Please follow these rules:
In general use, simply use the word as if it were any ordinary word, with no capitalisation or
highlighting: "Your placeholder can now be used."
At the start of sentences or titles, capitalise in the usual way: "Placeholder management guide".
When introducing the term for the the first time, or for the first time in a document, you may
highlight it to draw attention to it: "**Placeholders** are special model fields".
When the word refers specifically to an object in the code, highlight it as a literal:
"``Placeholder`` method reference".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment