@@ -360,7 +360,7 @@ Here are some guidelines to maintain a consistent style and voice across the doc
...
@@ -360,7 +360,7 @@ Here are some guidelines to maintain a consistent style and voice across the doc
- For example, _Next.js uses React_ instead of _React is used by Next.js_. If you find yourself using words like _was_ and _by_ you may be using a passive voice.
- For example, _Next.js uses React_ instead of _React is used by Next.js_. If you find yourself using words like _was_ and _by_ you may be using a passive voice.
- Avoid using words like _easy_, _quick_, _simple_, _just_, etc. This is subjective and can be discouraging to users.
- Avoid using words like _easy_, _quick_, _simple_, _just_, etc. This is subjective and can be discouraging to users.
- Avoid negative words like _don't_, _can't_, _won't_, etc. This can be discouraging to readers.
- Avoid negative words like _don't_, _can't_, _won't_, etc. This can be discouraging to readers.
- For example, _"You can use the `Link` component to create links between pages""_ instead of _"Don't use the `<a>` tags create links between pages_".
- For example, _"You can use the `Link` component to create links between pages"_ instead of _"Don't use the `<a>` tag to create links between pages"_.
- Write in second person (you/your). This is more personal and engaging.
- Write in second person (you/your). This is more personal and engaging.
- Use gender-neutral language. Use _developers_, _users_, or _readers_, when referring to the audience.
- Use gender-neutral language. Use _developers_, _users_, or _readers_, when referring to the audience.
- If adding code examples, ensure they are properly formatted and working.
- If adding code examples, ensure they are properly formatted and working.