Style Guide
This is the style guide for publications on this website. The goal is to make it as permissive as possible.
Headings
Do not use periods (.) and colons (:) at the end of the headings.
Use sentence case capitalization.
Links
Use straight quotes for a link label that
- uses the title of the page; and
- is multi-word; and
- does not fit within the sentence grammatically.
For example:
"[PAGE-TITLE](/)" is written by a human being.
Lists
Make the items in the list parallel in grammar.
For example:
You have three tasks for today.
- Eat breakfast
- Write a blog post
- Drink water
Do not write as the following:
Three important things.
- Breath
- Happy
- HTML
Dates and times
Dates must written in the following format: two-digit day of the month + the full month name + the full four-digit year. For example: 01 January 2022.
Use the 24-hour system.
Straight quotes and curly quotes
Use straight quotes.
Numbers
Write out the numbers zero to nine in letters.
Use digits for all numbers above nine.
Contractions
Do not use contractions.
| Do not write | Write |
|---|---|
| I'm a human. | I am a human. |
| They've gone. | They have gone. |
| We'll arrive at 6 o'clock in the morning. | We will arrive at 6 of the clock in the morning. |
Code blocks
Style any placeholders that people need to replace with their own values in all caps. For example: git branch BRANCH-NAME.
File names and directory names
Use backticks or HTML code element (<code>) to format file names and directory names. For example: README.md.
Word choice
Terms to use instead.
| Avoid | Use |
|---|---|
| front-end, front end | frontend |
| Xmas | Christmas |
| Catholic, Protestant | Catholic Christian, Protestant Christian |
| Non-Catholic, Non-Protestant | Non-Christian |
| utilize | use |
| blacklist, black list | blocklist |
| check box | checkbox |
See "My word choice in English and Indonesian" blog post for the rest of the word choice.
Currency
Use lowercase for currency names, capitalize the reference to the country or region, and add the International Organization for Standardization (ISO) standard currency code. For examples:
- 120 US dollars (USD)
- 15.000 ID rupiahs (IDR)
The list of the ISO standard currency codes can be found on the Wikipedia page for ISO 4217.