hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-27 16:57:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

sdk_style.md: Add information about preferred writing voice

Browse Source
This commit is contained in:
Karol Lewandowski 2025-03-03 12:46:08 +01:00
parent 59609dcfa1
commit a9162649cd
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
topics/intro/sdk_style.md
View File

@ -1,4 +1,4 @@
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# SDK Docs Style Guide
@ -320,6 +320,15 @@ For **SVG** images, use this notation:
</tabs>
### 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 <path>ijs.tree</path> file.