Update much style

This commit is contained in:
benjamin melançon 2020-08-21 14:27:51 -04:00
parent cd1ce8a772
commit ad35cd5ef1

View file

@ -252,7 +252,7 @@ One exception is when you want to specifically emphasize the action over the sub
We use a few different forms of capitalization. Title case capitalizes the first letter of every word except articles, prepositions, and conjunctions. We use title case for the titles of pages, including blog posts and basic pages. We use a few different forms of capitalization. Title case capitalizes the first letter of every word except articles, prepositions, and conjunctions. We use title case for the titles of pages, including blog posts and basic pages.
Sentence case capitalizes the first letter of the first word. Sentence case capitalizes the first letter of the first word.
When writing out an email address or website URL, use all lowercase. When writing out an e-mail address or website URL, use all lowercase.
micky@agaric.com micky@agaric.com
agaric.com agaric.com
@ -264,31 +264,37 @@ e-mail
#### Contractions #### Contractions
They are bad! Even though they may give your writing an informal feel, they provide difficulty for readers that donnot speak English. You can surely make your email look informal without the use of contractions. They are bad! Even though they may give your writing an informal feel, they provide difficulty for readers that do not speak English. You can make your writing informal without the use of contractions.
#### Emoji #### Emoji
Emoji are a fun way to add humor and visual interest to your writing, but use them infrequently and deliberately. Keep them out of blog posts and web copy entirely. Emoji are a fun way to add humor and visual interest to your writing, but use them infrequently and deliberately. Keep them out of blog posts and web copy entirely.
#### Numbers #### Numbers
Spell out a number when it begins a sentence or is under ten. Ten to twenty is a judgement call (but usually spelled out if not paired with numerals). Otherwise, use the numeral. This includes ordinals, too. Spell out a number when it begins a sentence or is under ten. Ten to twenty is a judgement call (but usually spelled out if not paired with numerals). Otherwise, use the numeral. This includes ordinals, too.
Ten new members started on Monday, and 12 start next week. Ten new members started on Monday, and twelve start next week.
I ate 3 doughnuts at coffee hour. I ate three doughnuts at coffee hour.
Meg won 1st place in last years hackathon. Meg won first place in last year's hackathon.
We hosted a group of 8th graders who are learning to code. We hosted a group of eighth graders who are learning to code.
(Sometimes it feels weird to use "1" instead of "one." Just go with your gut.) We attended the 33rd annual picnic.
One hundred trainees started the course but only 43 finished.
Numbers over 3 digits get commas: Numbers over 3 digits get commas:
999 999
1,000 1,000
150,000 150,000
Write out big numbers in full. Abbreviate them if there are space restraints, as in a tweet or a chart: 1k, 150k. Write out big numbers in full. Abbreviate them if there are space restraints, as in a tweet or a chart: 1k, 150k.
#### Dates #### Dates
Generally, spell out the day of the week and the month. Abbreviate only if space is an issue in the app. Generally, spell out the day of the week and the month. Abbreviate only if space is an issue in the app.
Saturday, January 24 Saturday, January 24
Sat., Jan. 24 Sat., Jan. 24
#### Decimals and fractions #### Decimals and fractions
Spell out fractions. Spell out fractions.
Yes: two-thirds Yes: two-thirds
No: 2/3 No: 2/3
@ -296,13 +302,16 @@ Best: ⅔
Use decimal points when a number cant be easily written out as a fraction, like 1.375 or 47.2. Use decimal points when a number cant be easily written out as a fraction, like 1.375 or 47.2.
#### Percentages #### Percentages
This depends on context - use the % symbol or spell out "percent" depending on which looks best. This depends on context - use the % symbol or spell out "percent" depending on which looks best.
#### Ranges and spans #### Ranges and spans
Use an en-dash (­) to indicate a range or span of numbers. (On Mac: Option + - (dash). On Windows: Control + -. On Debian with compose key enabled: compose + --.
Use an en-dash (­) to indicate a range or span of numbers. (On Mac: Option + - (dash). On Windows: Control + -. On Debian or Ubuntu with compose key enabled: compose + --.
It takes 2030 days. It takes 2030 days.
#### Money #### Money
When writing about US currency, use the dollar sign before the amount. Include a decimal and number of cents if more than 0. When writing about US currency, use the dollar sign before the amount. Include a decimal and number of cents if more than 0.
$20 $20
$19.99 $19.99
@ -311,19 +320,24 @@ When writing about other currencies, follow the same symbol-amount format:
€1 €1
#### Telephone numbers #### Telephone numbers
Use dashes without spaces between numbers. Use a country code if your reader is in another country. Use dashes without spaces between numbers. Use a country code if your reader is in another country.
555-867-5309 555-867-5309
+1-404-123-4567 +1-404-123-4567
#### Temperature #### Temperature
Use the degree symbol and the capital F abbreviation for Fahrenheit. Use the degree symbol and the capital F abbreviation for Fahrenheit.
98°F 98°F
#### Time #### Time
Use numerals and am or pm, with a space in between. Dont use minutes for on-the-hour time.
7 am Use numerals and am or pm, with a space in between. Do not use minutes for on-the-hour time.
7 am
7:30 pm 7:30 pm
Use an en-dash () between times to indicate a time period.
Use an en-dash () between times to indicate a time period.
7 am 10:30 pm 7 am 10:30 pm
Specify time zones when writing about an event or something else people would need to schedule. Since Agaric was founded and has several worker-owners in Boston, Massachusetts, we default to ET. Specify time zones when writing about an event or something else people would need to schedule. Since Agaric was founded and has several worker-owners in Boston, Massachusetts, we default to ET.