Introduction

The main goal of this page is to guide UA developers on creating good quality booster content.

Booster is a set of guided interactive steps that enable a customer to select, configure, and consume technical components. It helps to automate implementation phases and accelerate the SAP BTP adoption journey. Boosters represent steps inside a mission and wrap existing functionality, which is usually distributed over many tools and APIs, into a single user interface of a wizard.

Please note that the UA responsible for individual services should document the usage of boosters as part of their respective service guides. There is no central BTP Booster document maintained for individual boosters.

Getting Started

Introducing New Terms

When introducing new terms for Booster, make sure to comply with the standard terminology process for SAP BTP documentation.

Onboarding

• Keshav Rai will onboard the UA Developer to the project and the respective booster.
• Kavya M Gowda will guide the assigned UA through the booster content creation.

Guidelines

To support a coherent and consistent information flow from UA side, the UI elements and their respective texts are summarized in the following guidelines.

Note: A close collaboration and review cycles between development team, UX, and UA are highly recommended!

Booster Tab Pages

Boosters are presented in SAP BTP cockpit as object page with several tabs.
The header is static and includes the booster title and short description.

The tab titles are fixed in naming and sequence left to right:
Overview | Components | Additional Resources.

Screenshot: Booster page with three tabs Overview, Components, and Additional Resources.

Booster Title

Start with a verb, use title case, no punctuation, and respect a string length of 60 characters:

[Verb + outcome of the booster] Example: Prepare an Account for ABAP Development

Short Description

Start with a verb, use punctuation, and respect a maximum string length of 80 characters:

[Verb + more specific outcome of the booster.] Example: Create subaccounts, configure entitlements, and assign members.

Content of Overview Tab

The text in the overview tab is the face of the booster. The user gets to know what the booster is about, its benefits, and so on. This is accompanied by media content making the booster visually representative, providing information at a glance.

The text segments for the overview tab should contain three short paragraphs.

In the first paragraph, capture the goal of the booster. In the second paragraph, capture the information on what the booster does in terms of accelerating the implementation. In the third paragraph, capture the information on what users can do after the booster finishes executing.

Consider the following while creating and reviewing the overview tab content:

• Respect a max string length of 600 characters per paragraph.
• Use people-centric approach and repeat the outcome of the booster.
• Use the term 'booster' consistently to support the introduction of the new term Booster, and to avoid the creation of synonyms. Do not refer to the booster as template, template-like, or alike.
• Provide further details, such as its key features and benefits and keep the information as brief as possible. The overview tab content only provides the essential information of the booster.
• Use short names approved by Brand Voice.
• Check on appropriate media resources, such as solution diagrams, videos or illustrations, and discuss media content with your respective PO and PM. Simple graphics from the SAP BTP documentation are not recommended.

Content of Components Tab

To guarantee consistency across services presented in the Discovery Center, on SAP BTP cockpit, and in boosters, respect the following:

• Use the harmonized short name approved by Brand Voice
• Use the harmonized short description by UA

In case of questions or problems, contact Kavya M Gowda.

Content of Additional Resources Tab

The additional resources tab lists links to further information. Categorize the link aliases in the following pattern:

[openSAP: Link Name] | [Help Portal: Link Name] | [Developer Tutorials: Link Name]

In case you discover further link types, please address this to Kavya M Gowda.

Booster Wizard Pages

The booster wizard presents an interactive step sequence in a separate window overlaying the booster tab pages. See the screenshot for reference:

Screenshot: Interactive step sequence presented in a window overlaying the booster tab pages.

The default tabs are created and maintained by the Boosters core development team. The other steps in the wizard are created and maintained by the respective development teams. In special cases, the intermediate steps in the wizard are also maintained by the Boosters dev team based on the topic and domain. For more information, please contact Keshav Rai.

As an introduction, we differentiate between the following main UI text types on the booster wizard pages:

• Wizard Window Title
• Navigation Step Title
• Step Title
• Introducing Sentence
• Info Box
• Field Name
• Field Description

For a better understanding, see the following figure with UI elements and the relevant types for UA:

Main UI text types on the booster wizard pages

Wizard Window Title

The wizard window title repeats the booster title. See UA Guidelines for Booster Title above.

Navigation Step Title

Keep it very short, ideally in a two-term length. Consider product names as one term.

Start with a verb, use title case and no punctuation:

[Verb 2ndTerm] Example: Configure Services Note: Only use “configure” in the title when the respective wizard screen shows a configuration table, unlike the typical display of form fields, tiles, or lists.

Screenshot: Navigation Step Title

Step Title

For the step title, start with the step numbering using period. Continue by repeating the navigation step title: [12389. Navigation Step Title]

Example: 1. Setup Subaccount

Introducing Sentence

The introducing sentence always follows the step title. It explains briefly what the user can do in the respective step. Keep the sentence short (max length of 20 words), start with a verb, and use punctuation:

[Verb xy yyyz zz.]

Example: Specify the details of your ABAP system backend.

Info Box

The info box always follows the introducing sentence. It provides further details or background information in a conceptual style to put the respective step into context. Do not use more than 80 words.

Example: The required entitlements are assigned to the subaccount that is created and is deducted from the remaining quota of your global account.

Field Name

Field names are always introducing the respective UI field. Keep the field names in title case, nominal style, ideally one word is sufficient, and end it with a colon:

[FieldName:] Example: ABAP System ID

Field Description

Field descriptions are always following the respective UI field, e.g., dropdown, radio buttons, text field, etc. Keep the field descriptions short and do not use more than 25 words. Start by repeating the field name, keep the sentence in conceptual style, and use punctuation:

[FieldName xx xy yz zz.] Example: The unique identifier for the application, in reverse-domain notation.

Exceptions for Field Descriptions in Configuration Step

In the configuration step of the step sequence (e.g., “Configure xyz”), the wizard displays grouped fields in a table-like style. In this case, no field descriptions are required.

Note: This is a workaround until further notice.

Support

In case of questions or problems, contact Kavya M Gowda.