You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/style-guide.md
+32-18Lines changed: 32 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -389,34 +389,48 @@ When writing new documentation, use the following [templates](/templates):
389
389
390
390
## Language guidelines
391
391
392
-
- Prefer active voice and goal-oriented phrases:
392
+
### Write for global readers
393
393
394
-
| Do | Don't |
395
-
|----|-------|
396
-
|_To restart the system, run the following command.__|_ For the system to be restarted, run the following command._ <br> Restarting the system can be achieved, if necessary, by running the following command._|
394
+
Write at an 8th–9th grade reading level. Use clear, simple language. Choose everyday words instead of technical terms when possible. Avoid jargon unless it’s needed and defined in context. This helps people around the world understand our content, including those who speak English as a second language or use machine translation.
397
395
398
-
- Prefer that for essential clauses, which for non-defining details.
396
+
Use the [Flesch-Kincaid readability calculator](https://goodcalculators.com/flesch-kincaid-calculator/) to check your writing if needed.
399
397
400
-
- For optional, required, and forbidden actions, use proper modal verbs instead of ambiguous conditionals:
401
398
402
-
| Do | Don't |
403
-
|----|-------|
404
-
|_You may/should/must add additional security by following this guide._|_If more security is necessary, follow this guide._|
399
+
- Use the active voice and write goal-oriented instructions.
405
400
406
-
For more information about modal verb semantics, see [RFC-2119](https://tools.ietf.org/html/rfc2119).
401
+
| Do | Don’t |
402
+
|----|--------|
403
+
|_To restart the system, run the following command._|_For the system to be restarted, run the following command._<br>_Restarting the system can be achieved by running the following command._|
407
404
408
-
-In code snippets, follow established style conventions of respective languages, including indentation, line breaks, and naming.
405
+
-Use **that** for essential information and **which** for extra details.
409
406
410
-
- Omit unnecessary words and phrases, courtesy sugaring in particular.
407
+
| Do | Don’t |
408
+
|----|--------|
409
+
|_Restart the services that failed during the update._<br>_Open the folder that contains your configuration files._|_Restart the services, which failed during the update._<br>_Open the folder, which contains your configuration files._|
411
410
412
-
| Do | Don't |
413
-
|----|-------|
414
-
|_To enable this feature, do that._|_Oops! To enable this feature, please do that._|
411
+
Use **which** only when the clause adds nonessential information:<br>
412
+
_The log file, which records all system activity, can grow large over time._
415
413
416
-
- Use hyphens to join compound adjectives before nouns, not after.
414
+
- Use clear modal verbs to show when actions are optional, required, or forbidden.
417
415
418
-
| Do | Don't |
419
-
|----|-------|
416
+
| Do | Don’t |
417
+
|----|--------|
418
+
|_You may/should/must add more security by following this guide._|_If more security is necessary, follow this guide._|
419
+
420
+
For more information about modal verbs, see [RFC 2119](https://tools.ietf.org/html/rfc2119).
421
+
422
+
- In code snippets, follow the standard code style for each language. Keep indentation, line breaks, and naming consistent.
423
+
424
+
- Cut extra words and politeness phrases that don’t add value.
425
+
426
+
| Do | Don’t |
427
+
|----|--------|
428
+
|_To enable this feature, run this command._|_To enable this feature, please run this command._|
429
+
430
+
- Use hyphens in compound adjectives before nouns, not after.
431
+
432
+
| Do | Don’t |
433
+
|----|--------|
420
434
|_A well-known feature._|_A feature well-known._|
421
435
|_The feature is well known._|_The feature is well-known._|
0 commit comments