Writing guide
We recommend engineers to follow these guidelines.
Last updated
Was this helpful?
We recommend engineers to follow these guidelines.
Last updated
Was this helpful?
1. Correctness
Avoid common English language mistakes.
More details:
2. Consistency, organization, and visual appearance
Use consistent font face, color, and size.
Use consistent casing.
Use consistent punctuation.
For example, have a clear logic for using dots at the end of each bullet point phrase.
Try use only one to three colors.
3. Minimalism
Keep only phrases and words that add significant meaning.
4. Positivity
Use positive words instead of negative where possible.
5. Clarity
Make sure the words you mention are known by the typical reader or make sure to explain them.
Consider keeping abbreviations only for very commonly used terms in your field or for (making sure your resume shows up for keyword searches). It looks like didn't like acronyms too. Here is what his email about acronyms to the team allegedly looked like: .
OK: SQL or CSS.
Not OK: BDD (Behavior-Driven Development)
6. Simplicity
Use the language and structure that is as simple as possible, .