From cd89ec13868b4b022bd1a296ceff3f96580edc2f Mon Sep 17 00:00:00 2001 From: Steven Higgs Date: Sun, 17 Nov 2024 08:37:39 -0700 Subject: [PATCH] EXM-54985: Small improvements (mostly punctuation) Signed-off-by: Steven Higgs --- ...tron-assistant-retrospective-analysis.dita | 45 ++++++++++--------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/topics/ai-positron-assistant-retrospective-analysis.dita b/topics/ai-positron-assistant-retrospective-analysis.dita index 6a6a711..3a2bfab 100644 --- a/topics/ai-positron-assistant-retrospective-analysis.dita +++ b/topics/ai-positron-assistant-retrospective-analysis.dita @@ -10,14 +10,15 @@

It's been more than one year since we started working on the , back when the OpenAI GPT 3.5 AI engine was - released and we are currently on version 4.0.0 of the add-on. Our main direction (which we - still keep) was to provide powerful tools based on AI engines for technical documentation - writers (targeted mostly towards DITA XML users) and for our XSLT/Schematron developers. I've - always envisioned the AI set of tools as an exoskeleton, as a way to add more power to a - technical documentation writer's punch throughout the day. The table below contains a list of - concepts (mostly add-on specific features or feature categories), each with a short - description based on personal experience.

+ href="ai_positron.dita"/>, back when the OpenAI GPT 3.5 AI + engine was released, and we are currently on version 4.0.0 of the add-on. Our main + direction (which we still keep) was to provide powerful tools based on AI engines for + technical documentation writers (targeted mostly towards DITA XML users) and for our + XSLT/Schematron developers. I've always envisioned the AI set of tools as an + exoskeleton, as a way to add more power to a technical documentation writer's punch + throughout the day. The table below contains a list of concepts (mostly add-on specific + features or feature categories), each with a short description based on personal + experience.

Eating our own dog food?Are we using AI tools ourselves? Yes, I have started using AI tools more and more to improve readability and fix grammar or logical inconsistencies in articles like this one. I don't ask the AI to create new article @@ -47,7 +48,7 @@

So are all AI engines equal? Our predefined actions have and are actively tested with OpenAI engines and with engines provided by Anthropic Claude. We also tried to use engines like Llama 3.1 or Mistral with our current - predefined actions but the results are not fantastic, the possibility to obtain + predefined actions but the results are not fantastic, as the possibility to obtain broken DITA XML content with these open source engines is much higher.

Predefined actionsOver time, we improved how we write prompts for @@ -57,7 +58,7 @@ For each action, we try to give a clear prompt with lots of details so the AI engine can produce the best results. We test our predefined actions using both manual and automatic tests. We got the best results with Open AI GPT-4 engines and the engines provided by - Anthropic Claude like Sonnet.
+ Anthropic Claude, like Sonnet.
Custom actionsWe wanted to give companies the flexibility to create their own
Content generation -

There are two main ways AI based content generation can be useful:

+

There are two main ways AI-based content generation can be useful:

    -
  • Summarizing a large amount of text. For example predefined actions like +
  • Summarizing a large amount of text. For example, predefined actions like Short Description try to summarize a big piece of content. These actions usually work very well.
  • Expanding a small amount of text. Content generation actions like Add @@ -94,7 +95,7 @@ screenshots.
Rewrite actionsWe created useful actions to Correct Grammar, Improve Readability, Use Active Voice, and Improve Structure. - These actions are applied to existing content, they have precise prompts which instruct + These actions are applied to existing content, they have precise prompts that instruct the AI to preserve the existing content as much as possible, and they are solid examples of how the AI can help a writer during their daily work.
Review actionsAt some point, we had the idea that the AI, instead of @@ -108,7 +109,7 @@ or report on the Readability of a DITA XML topic. We also created actions to use AI to better understand what questions a certain topic answers. In the future, using an AI engine might also include asking the AI to find logical inconsistencies in - already written content, which may be too large for a person to fully digest + already written content that may be too large for a person to fully digest easily.
Translate actionsThere are studies that say the translation abilities in AI engines are better than Google Translate or DeepL. The @@ -152,15 +153,15 @@ not use all the specialized DITA XML elements.

Third Party CMS supportBoth Oxygen desktop and in-browser editing tools can be integrated with various content management systems. Most AI predefined - actions should work when Oxygen is integrated with third-party CMSs. However, actions + actions should work when Oxygen is integrated with a third-party CMS. However, actions that write content on disk (like actions from the Intelligent agents category) - might not be able to create new topics on the CMS. Actions improved by using RAG - (retrieval augmented generation) might also not work well since the project content is - stored on the CMS. Oxygen desktop has an Enable indexing for remote - resources checkbox on its Open/Find Resource page - in Preferences. This allows our indexing engine to index content from the CMS. - But the in-browser WebAuthor editing tool does not yet support indexing CMS-specific - content.
+ might not be able to create new topics on the CMS. Actions that are improved by using + RAG (retrieval augmented generation) might also not work well since the + project content is stored on the CMS. Oxygen desktop has an Enable indexing + for remote resources checkbox in the Open/Find + Resource preferences page. This allows our indexing engine to index + content from the CMS. But the in-browser Web Author editing tool does not yet support + indexing CMS-specific content.

I hope this article, based on my experience working on AI editing tools and with AI editing tools, will be useful to you. As always, you can leave feedback using the Oxygen Feedback form, which appears below this published article.