This topic describes the accessibility features available for your service, like screen reader support or high-contrast settings.

information
This requirement was rolled out in the BTP T&I UA Community Meeting on 15 June 2022. See the meeting minutes and presentation.
<div> <div>Target Group</div> <div>Application end-user</div> </div> <div> <div></div> <div>Mandatory</div> </div> <div> <div></div> <div>One topic, but not all sections are mandatory</div> </div>

Basic Considerations

To get started, contact your development team and/or product owner to figure out what accessibility features are available for your service. Examples for accessibility features are screen reader support, high-contrast settings etc.

One of the following use cases probably applies to you:

Topic Content

To ensure uniformity, please use the following for your topic:

Title: Accessibility Features in <service short name>

Use "Accessibility Features in <service short name>" as the title of your topic. Do replace it with another title.

If you already have accessibility information in your service guide, simply link to it here. Do not repeat the information.

Topic Sections

Based on the features available for your service, some sections of the template might be optional:

General (mandatory)

The General section consists of a short note on the underlying technology, a link to the SAP BTP cockpit or SAP UI5 documentation, and an overview table for additional features that your service might have. Also link to other services a user might come in contact with while using your service.

Keyboard Shortcuts (optional)

If your service has keyboard shortcuts that are specific for your service, describe them shortly in the table in this section. If you already have documentation on this topic, to it here - .

Use <name of the feature> (optional)

Create this section once for each accessibility feature. Describe the prerequisites, context, and steps required to enable the feature for your service.

This section should exist once for every feature that requires extra explanations: if your service has N extra features, your topic should have the sections , (,) , ... .

Depending on your use case, delete the section(s) you don't need. Then, get started following the template's instructions to fill in placeholders etc. and replace them with your specific information.

Examples

1
dont
false

Not Recommended

  • Don't use the terms accessibility or accessible besides where they're used in the template already.
    The word accessible is critical because it can mean both "free of barriers" and "available", and can come with legal implications. In documentation, it should be used with caution. For more information and examples, see Accessibility - Knowledge Management.
  • Don't delete or move any existing topics or sections.
    This accessibility topic is additional information and should not replace existing topics on accessibility features (e.g. keyboard shortcuts). If you have existing documentation, refer and link to it in this topic, but don't remove the existing topics from your documentation so users can still find them.

Support

If you need help, contact the DL BTP Design Accessibility or .

Accessibility in general:

Accessibility documentation

Frequently Asked Questions

If your service has no UI whatsoever and is not opened or provisioned via an SAP service (e.g. SAP BTP cockpit), you don't need a topic. But as soon as a user has to interact with another service, please create a topic and link to the service's documentation in it.

Yes! But you don't have to document the features provided by SAP BTP cockpit yourself. Create a topic with only the General section in it, and link to the cockpit's topic in it.

No, please don't list features that aren't available for your service. Get in contact with us and we'll figure out a good way for you to document the accessibility features available for your service.