Accessibility Features
Product Specifics / Service Guide Template
This topic describes the accessibility features available for your service, like screen reader support or high-contrast settings.
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:
- Your service only has those accessibility features that are implemented through the technology you're using, e.g. SAPUI5 (Accessibility for End Users) or SAP BTP cockpit (CF: Accessibility Features in SAP BTP Cockpit; Neo: Accessibility Features in SAP BTP Cockpit). No other features exist on top.
- Your service has accessibility features implemented through the technology you're using, and one or more features specific to your service come on top, e.g. keyboard shortcuts, or other features that require explanations.
- Your service has no user interface, so there are no accessibility features to document. In that case, no topic is required.
Topic Content
To ensure uniformity, please use the following for your topic:
- In DITA CMS, search for topic loiob710e90c8f0e455892cec41d0b33c8a2 ("[Template] Accessibility Features in <service short name>", version 1, CP_TOP).
- Use copy with new loio and copy the topic to your documentation.
- Your accessibility documentation topic should be located in the central documentation of your service. For most services, this is at the bottom of the What Is ... map.
Title: Accessibility Features in <service short name>
Use "Accessibility Features in <service short name>" as the title of your topic. Do not 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.
If your service is part of a bigger product/service, e.g. it runs on SAP BTP cockpit or is part of SAP Integration Suite, and no extra features come on top, the General section might be all you need. But please talk to you dev team before dismissing the other sections. For example, if your onboarding happens via SAP BTP cockpit, you should still link to its accessibility documentation.
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 – don't delete existing documentation.
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 General, (Keyboard Shortcuts,) Use <Feature 1>, ... Use <Feature N>.
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
- Accessibility Features in SAP BTP cockpit
- Accessibility Features in SAP Credential Store (part of SAP BTP cockpit)
- Accessibility Features in SAP Custom Domainservice (independent UI)
- 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 Melanie Cueppers.
Want to know more about accessibility?
Accessibility in general:
Accessibility documentation
- Accessibility in the SAP Style Guide for Technical Communication
- Accessibility - Knowledge Management
Frequently Asked Questions
Q: My service doesn't have a user interface and only runs in the background. Do I still need a topic?
A: 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.
Q: My service is part of SAP BTP cockpit. Do I need my own topic?
A: 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.
Q: My service doesn't comply with SAPUI5 standards, so some accessibility standards aren't possible in my service. Can I list those restrictions?
A: 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.