diff --git a/topics/intro/sdk_style.md b/topics/intro/sdk_style.md index 26539798f..5f681a3df 100644 --- a/topics/intro/sdk_style.md +++ b/topics/intro/sdk_style.md @@ -1,4 +1,4 @@ - + # SDK Docs Style Guide @@ -320,6 +320,15 @@ For **SVG** images, use this notation: +### Other + +1. Use a concise and neutral voice when describing topics: + - **Avoid:** "A custom icon for files with a substituted language would be a great addition to the plugin. It is easy as implementing the `xyz` extension point." + - **Prefer:** "To add a custom icon for files with a substituted language, implement the `xyz` extension point." +2. Avoid directly addressing the reader and the author with "you", "your", "we", etc. + - **Avoid:** "Add a dependency in your plugin descriptor." + - **Prefer:** "Add a dependency in the plugin descriptor." + ## Table of Contents The table of contents for the site is displayed in the tree view on the left side of the site, and it is generated from the ijs.tree file.