Built-in AI Actions

• Generate image alternate text - Generates an alternate text for an image that is selected in the main editing area or for all images in the entire document when working with DITA XML content in the Author visual editing mode.
  Tip:

  Conveniently access this action by clicking the Generate alternate text button that is available from the floating toolbar that appears when you select an image.

• Generate documentation draft - Generates a documentation draft of a DITA XML topic based on a configuration file that fine tunes the generation process by specifying the context, audience, summary, instructions, images, and a similar topic to help the AI generate the draft content.
• New DITA topic - Generates a DITA XML topic based on a text description entered in a popup dialog box. For Oxygen version 27 and newer, related content from the current set of project resources is also taken into account.
• Update content based on images - Updates the content of a DITA XML topic based on the images that it references.
• Short description - Generates a short description ( inside a <shortdesc> element) based on a summary of the selected text (or the entire document if there is no selection). You can configure the style and the approximate number of sentences to be generated.
• Index terms - Generates a <keywords> element that contains index terms obtained from the selected text (or the entire document if there is no selection).
• Formula/Equation - Generates an AI proposal for a MathML formula or equation based on information provided by the user when invoking the action (for example, a description of a substance, physics formula, mathematical expression, or LaTeX equation).
• Follow instructions (available for XSLT, Schematron, XSD, CSS, XQuery, JSON, and JSON Schema) - Replaces the selected instructions with content generated based on them.

• Correct grammar - Generates a suggestion for correcting the grammar and spelling within the selected content.
• Improve readability - Modifies the selected content to improve readability and fix grammar/spelling errors. If you hover the mouse prompt over this button, a Settings button becomes available in the top-right corner. Clicking the Settings button opens a pop-up window where you can choose the writing level of the content to be generated. You can choose between: Beginner, Intermediate, Advanced, and Expert.
• Use active voice - Generates a suggestion for replacing the selected content with content that has been converted from passive to active voice.
• Improve structure - Improves the selected DITA XML content by adding additional structure or inline elements.
• Itemize - Generates a suggestion for converting the selected content into a list of items.
• Join items - Generates a suggestion for converting the selected list of items into a paragraph.

The Correct grammar, Improve readability, Use active voice, and Improve structure actions can apply changes directly in the document as targeted edits, instead of returning the entire content for you to insert. This approach is faster and more efficient for large documents because only the modified parts are returned by the AI. When changes are applied this way, the Insert/Replace button is not available because the changes are already in the document. Also, the Preview button is replaced with Review changes, which provides a visual preview of the changes that were already made, and you have the options to Keep changes or Reject changes.

• Proofread - Adds comments in content that has logical consistency problems, grammar or spelling mistakes, or is hard to read and comprehend.
• Resolve comments - Changes the selected content based on the suggestions within comments and then removes the comments.

These actions can apply the translation directly in the document, as targeted edits, rather than returning the whole content for you to insert. This is faster and cheaper on a large document, since only the changed parts travel back from the AI. When the translation is applied this way, the Insert/Replace and Preview buttons are not offered, because the changes are already in the document.

• Generate agent instructions - Generates a project context prompt that helps the AI understand your documentation project. The action analyzes the structure and conventions of a project’s structure. It generates comprehensive AI instructions tailored to the project’s specific organization, framework, and metadata requirements, ensuring that subsequent AI-generated content remains aligned, consistent and framework-compliant. The generated context prompt is automatically saved in your project as a Markdown file and used by AI Positron onward when using the chat or available AI actions.
• Create topics - Generates DITA XML topics based upon user input, incorporating relevant project content. It creates a topic hierarchy, assigns DITA document types, and proposes a DITA map location. Topics are then saved and added upon user approval. The AI considers the DITA map opened in the DITA Maps Manager and the selected topic and then looks for similar content in topics gathered from the related links or through the Retrieval-Augmented Generation (RAG) process. After the action processes, a Preview dialog box shows the list of proposed changes.
• Expand draft - Enhances a draft of a DITA XML topic by refining the existing content, adding new content, adding markup that is consistent with similar topics, and generating documentation based on the referenced images using the Vision support. The AI looks for similar content in topics gathered from the related links or through the Retrieval-Augmented Generation (RAG) process.
• Split topic - Analyzes the current DITA XML topic based on modular document development best practices. If the topic is too large or contains multiple subjects, the AI may split it into several topic files. References to the new topics are also added in the DITA map that is currently open in the DITA Maps Manager. After the action processes, a Preview dialog box shows the list of proposed changes.
• Fix validation problems - Validates the entire content of the current document, finds problems, and then uses AI to fix all the reported problems.
• Fix terminology problems [optional] - When installed along with the latest Terminology Checker add-on, this action that is contributed by the Terminology Checker gathers terminology problems from the entire content of the current document, and then uses AI to fix all the reported problems.

• Analyze and update topic - This action analyzes and optimizes your DITA topics to ensure modularity and consistency. It reviews and updates the topics to align with the DITA standards, generates new topics, and updates the DITA map as needed.
• Convert to [DITA_TYPE] - Actions that convert plain text, Markdown, or DITA content to a specific type of DITA topic:
  • Task - A topic type used to describe a series of steps to accomplish a specific goal. It is ideal for procedural information.
  • Concept - A topic type used to explain an idea, definition, or concept. It is typically used for background or explanatory information.
  • Reference - A topic type used to provide detailed, structured information such as tables, lists, or specifications. It is often used for quick look-up information.
  • Troubleshooting - A topic type used to describe problems, their causes, and solutions. It is designed to help users resolve issues effectively.
  • Glossary - A topic type used to define terms and provide explanations. It is commonly used to build a glossary of terms for a project or document.