AI-powered writing
In Writerside, you can take advantage of AI-based features specifically designed to enhance your writing experience.
Context-aware actions enable you to rephrase, review, or translate selected text into English. Also, there are actions that generate various elements based on the content: TLDR, link summary, or web summary for SEO.
These actions are based on Grazie, an AI writing companion from JetBrains. More specifically, you need to install and enable the Grazie Pro plugin.
Install Grazie Pro
Press Ctrl+Alt+S to open the Writerside settings and select .
Switch to the Marketplace tab, search for
Grazie Pro, select the plugin, and click Install.
Rephrase
You can ask Writerside to suggest alternative wording for a selected content fragment. It will generate three variants of text that is similar in tone and meaning, and it will try to preserve the markup as much as possible.
Use this feature as a writing companion when you are stuck with the wording and want to explore other ways of conveying your idea.
Select any text in the editor, press Alt+Enter or right-click and select Show Context Actions, then click Rephrase.
Writerside will show three variants how to phrase the selection.
Review
You can ask Writerside to rewrite a selected fragment to make it more readable, clear, concise, and grammatically correct.
Select any text in the editor, press Alt+Enter or right-click and select Show Context Actions, then click Review.
Writerside will suggest how you can rewrite the selection and show it in a difference viewer. If you are satisfied with the result, accept the suggestion.
Translate to English
You can ask Writerside to translate any selected content fragment into English. Thus, you can author documentation in your native language and then translate it, preserving the markup.
Select any text in the editor, press Alt+Enter or right-click and select Show Context Actions, then click Translate to English.
Writerside will generate a translation of the selected text in English and show it in a difference viewer. If you are satisfied with the result, accept the suggestion.
Generate TLDR
You can ask Writerside to generate a TLDR block for a lengthy topic or chapter. The goal of this element is to give your reader an extract with the most essential info on the subject you're describing to spare them the need to read into the details.
With the caret in the editor, press Alt+Enter or right-click and select Show Context Actions, then click Generate TLDR.
If the caret is placed inside a chapter element, you will be prompted to choose whether you want to generate a TLDR for this chapter or the entire topic.
Writerside will generate a TLDR block at the beginning of the chapter or topic and will display it in the difference viewer. If you are satisfied with the result, accept the suggestion.
Generate SEO metadata
Writerside uses the <web-summary> element to produce meta descriptions of pages in your help website. These are not visible to your readers and are used by search engines to better index your content.
By default, Writerside uses the first paragraph as a web summary, but you can override it using the <web-summary> element. Writerside can suggest a web summary based on the topic content.
With the caret in the editor, press Alt+Enter or right-click and select Show Context Actions, then click Generate SEO Metadata.
Writerside will suggest a web summary at the beginning of the topic and will display it in the difference viewer. If you are satisfied with the result, accept the suggestion:
Generate link summary
Link summaries are used to display a short summary of a topic or an anchor in a popup when you hover over a link. They help your readers understand what the linked content is about before following a link.
By default, Writerside uses the first paragraph as a link summary, but you can override it using the <link-summary> element in a <topic> or <chapter>. Writerside can generate a link summary based on the contents.
With the caret in the editor, press Alt+Enter or right-click and select Show Context Actions, then click Generate Link Summary.
If the caret is placed inside a chapter element, you will be prompted to choose if you want to generate a link summary for this chapter or the entire topic. If you place the caret on a reference, that is inside the
<a>element, a link summary will be generated for the target topic, not the current one.
Writerside will generate a link summary at the beginning of a chapter or topic and will display it in the difference viewer. If you are satisfied with the result, accept the suggestion: