Documentation nitpicks - crccheck/crccheck.github.io GitHub Wiki
Capitalize proper nouns. In tech, many tools are also dictionary words. Use the capitalization the tools' owners intended. For example:
- celery the vegetable vs Celery the task runner
- Sass and SCSS
- rest vs REST as in APIs
- Vault the Hashicorp product vs vault (1Password vault, or bank vault, or a generic secret vault)
When tech tools have lowercase names to be cool, use backtick quotes. For example:
npm
Use "down style" for headings. Capitalizing everything makes it easy to confuse what's a proper noun. https://www.dailywritingtips.com/up-style-and-down-style/