Process Overview

Product Specifics / SAP BTP Services

Understanding the Content

As the UA developer for a service, you are responsible for the texts displayed in the SAP Discovery Center and the SAP BTP Cockpit.

The following graph presents the UA content you're responsible for, where it is stored, where it is displayed, and what kind of audience it's targeting.

Understanding the Process

For more information about where the Metadata is used, refer to the Knowledge Center article: Onboard your App/Service to the BTP Metadata, section Where is the BTP Metadata Used?

As the UA developer for a service, you are involved in several steps of the overall creation or maintenance process for your service. The CISC-5 JIRA ticket fully describes this process. The two sub-tasks involving a UA expertise are:

Note that the process is different depending on whether you're working on the creation of a new service or on the update of an existing service.

We recommend that you keep the process graphs nearby when going through the CISC sub-tasks to help you have a better understanding of how the described tasks relate to each other.

Image
1
47.32; 7.00
For more details on how to create the Data Sheet in the DITA CMS, refer to
Service Data Sheet.

Graphic_Guidelines_ProcessCreation

UA Process when Creating a New Service

Graphic_Guidelines_ProcessUpdate

UA Process when Updating an Existing Service

Using the Writing Guidelines

The following pages provide you with the guidelines needed to write the content described in the Content Overview section.

The following table indicates where the guideline for each element is located.

<div> <div>Guideline Section</div> <div>Elements</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fservice-metadata%2Fservice-names-and-descriptions%2F">Service Names and Descriptions</a></div> <div> <p>Service name</p> <p>Service description</p> </div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fservice-metadata%2Fservice-features%2F">Service Features</a></div> <div>Service Features</div> </div> <div> <div><a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Fbtp%2Fwriting-guidelines%2Fproduct-specifics%2Fservice-metadata%2Fservice-plan-names-and-descriptions%2F">Service Plan Names and Description</a></div> <div> <p>Service plan name</p> <p>Service plan description</p> <p>Technical plan name</p> <p>Technical plan description</p> </div> </div>