Merge pull request #913 from oracle-devrel/updatedDescriptions

al3xne · web-flow · commit e4fe68ce6dd5 · 2024-03-26T11:41:20.000+02:00
updatedDescriptions
diff --git a/ai-and-app-modernisation/ai-services/oracle-digital-assistant/oda-workshop/README.md b/ai-and-app-modernisation/ai-services/oracle-digital-assistant/oda-workshop/README.md
@@ -1,4 +1,4 @@
-# ODA Workshop
+# Conversational Design Experience (CDX) Workshop
  
 Organizations are looking for ways to improve the customer
 experience and employee experience. With the rise of
diff --git a/ai-and-app-modernisation/ai-services/oracle-digital-assistant/solution-definition/README.md b/ai-and-app-modernisation/ai-services/oracle-digital-assistant/solution-definition/README.md
@@ -1,16 +1,19 @@
-# ODA Solution Definition
+# Solution Definition Document ODA
  
 This is a documentation template for an ODA solution. It's based on an architecture best-practices pattern and needs to be tailored for different use cases and requirements.
+This document provides a high-level solution definition for the Oracle Digital Assistant solution and aims at describing the current state, to-be state as well as a potential project scope and timeline.
 
 Reviewed: 30.01.2024
  
 # When to use this asset?
  
 When you design a solution and want to describe it in a solution document.
+The intended purpose is to provide all parties involved a clear and well-defined insight into the scope of work and intention of the project as it will be done as part of the Oracle service.
  
 # How to use this asset?
  
 Use the Word or Markdown template, and fill in the chapters with your relevant content and context.
+Describe the customer's business and background. What is the context of the customer's industry and LoB? What are the business needs and goals that this Workload is an enabler for? How does this technical solution impact and support the customer's business goals? Does this solution support a specific customer strategy, or maybe certain customer values? How does this solution help our customers to either generate more revenue or save costs?
  
 # License
  
diff --git a/ai-and-app-modernisation/ai-services/oracle-digital-assistant/templates/concierge-template/README.md b/ai-and-app-modernisation/ai-services/oracle-digital-assistant/templates/concierge-template/README.md
@@ -1,16 +1,38 @@
-# Concierge Template
+# Oracle Digital Assistant Concierge Template
  
-TBD
+The Concierge Template is a skill for quickly setting up a Knowledge bot.
 
-Reviewed: 30.01.2024
+Concierge Template WebSDK
 
-# When to use this asset?
+Setup:
+  To use this web-sdk for your bot you minimally need to do the following:
+    1. In the scripts/concierge.js file:
+        line 3: Enter the URI of your ODA instance in the format shown
+        line 5: Enter the channelId of the webchannel you created in ODA
+    2. Use the sample index.html or add the following lines in the <head> section of your html-page:
+        <script src="scripts/concierge.js" defer></script>
+        <script src="scripts/settings.js" defer></script>
+        <script src="scripts/web-sdk.js" onload="initSdk('Bots')" defer></script>
 
-TBD
+Images:
+  Under /images you can find all images used by the template; change/overwrite them to your liking
 
-# How to use this asset?
+Colors:
+  In the colors section (search for 'colors:') of scripts/concierge.js file you can find all html-colorcodes
+  Remarks behind each entry explain what the color is used for.
+  A few less changed colors are also in style/concierge.css. (search for '#')
 
-TBD
+Languages:
+By default this template uses the language of the browser user profile.
+You can change that by adding the language code to the initSdk function in your html page:
+  <script src="scripts/web-sdk.js" onload="initSdk('Bots','fr')" defer></script>
+In the i18n section (search for 'i18n:') in the scripts/concierge.js file you can add a language section with all translations of texts used by the widget.
+You can manage the language menu of the chatwidget with the multiLangChat section (search for 'multiLangChat:') in the scripts/concierge.js file 
+In the function getConciergeValues(search for 'function getConciergeValues') in the scripts/concierge.js file you have to check if you need to add your new language section
+
+Passing values to your bot:
+In the initUserProfile section (search for 'initUserProfile:') in the scripts/concierge.js file you can add values to be used by your bot. Custom parameters can be added in the profile/properties section.
+In your freemarker expression you can use them like profile.properties.value.company (check variables in the skill tester).
  
 # License
  

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# ODA Workshop`
	`1`	`+# Conversational Design Experience (CDX) Workshop`
`2`	`2`
`3`	`3`	`Organizations are looking for ways to improve the customer`
`4`	`4`	`experience and employee experience. With the rise of`