Writerside Help

AI Assistant

In Writerside, you can take advantage of the AI-based features specifically designed to enhance your writing experience:

  • Context-aware actions for adjusting text – rephrase, re-write, or translate selected text into English.

  • AI-based content generation – generate a TLDR, a web summary for SEO, or a link summary.

  • Integrated AI Assistant chat – interact with AI to accelerate your work without leaving your writing environment.

Set up the AI Assistant plugin

  1. When you install Writerside version 241.16003 or later, you will notice the AI Assistant icon in the right pane, next to Writerside Preview:

    AI Assistant icon

    Click it to open the AI Assistant tool window:

    AI Assistant
  2. Click Install Plugin, wait until it is downloaded, and restart Writerside.

  3. Click Start Free Trial.

  4. Log in with your JetBrains Account or click Register if you do not have it yet.

  5. After your license is activated, you will get access to the built-in AI Assistant chat and the AI Actions context menu:

    AI Assistant actions become available

Rephrase

You can ask the AI Assistant to suggest alternative wording for a selected content fragment. It will generate 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 to show the context menu, expand AI Actions, and select Rephrase.

Writerside will open a new AI Assistant chat with the request to suggest three options to rephrase selected text:

AI Assistant tool window with the prompt to rephrase selection

Review

You can request the AI Assistant to improve your content and re-write to make it more readable, clear, concise, and grammatically correct.

  • Select any text in the editor, press Alt+Enter or right-click to show the context menu, expand AI Actions, and select Review.

The AI Assistant will open a new editor tab where you will be able to see the difference between the suggested version and your current version. If you are satisfied with the result, accept the suggestion:

AI Assistant diff

Translate to English

You can ask AI Assistant to translate any selected content fragment into Enlgish. 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 to show the context menu, expand AI Actions, and select Translate to English.

The AI Assistant 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:

AI Assistant diff

Generate TLDR

You can ask the AI Assistant 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 to show the context menu, expand AI Actions, and select 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.

The AI Assistant will generate a TLDR block at the beginning of the chapter/topic and will display it in the difference viewer in a separate editor tab. If you are satisfied with the result, accept the suggestion:

AI Assistant diff

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. AI Assistant can suggest a web summary based on the topic content.

  • With the caret in the editor, press Alt+Enter or right-click to show the context menu, expand AI Actions, and select Generate SEO Metadata.

The AI Assistant will suggest a web summary at the beginning of the topic and will display it in the difference viewer in a separate editor tab. If you are satisfied with the result, accept the suggestion:

AI Assistant diff

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>. AI Assistant can generate a link summary based on the contents.

Last modified: 18 June 2024