# Plugin Development Notes for JetBrains IDEs

## Code

* Code examples use the `com.example` package root, but in some circumstances might be shortened to just `example`
*

## Recommendations

Some pages will have a section called Recommendations. This section is meant to be "best practices" related to the topic. It includes common patterns used by plugin developers or personal prescriptions.

## Abbreviations

* Class Types
  * A - Abstract
  * I - Interface
  * C - Class

## TODO

* update upsource links to space
* consolidate all code links to either space or github


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://intellij.pluginwriting.academy/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
