Info (warning)

warning

The following Features Scope Description guidelines apply to SAP Business Technology Platform products and services created by SAP T&I (Technology & Innovation).

Introduction

The feature scope description (FSD) is a mandatory deliverable for SAP products, in the form of a self-contained PDF without links to other deliverables. It's legally binding and its goal is to list all the functions and features of an SAP product from a high-level, purchase-decision perspective: What is the customer buying? What functions and features is the customer entitled to use? It forms the basis of the contract and SAP's legal obligations to the customer.

See Legal Aspects: User Assistance in the SAP Style Guide for Technical Communication.

Guidelines

Use the following information as a basis for creating your service FSD:

Provide an overview of compliance and security certificates.
Provide an overview of different availability aspects.
Explain how the SLA for SAP BTP is structured.
Describe which browsers the UI supports.
Describe one service only.
Create a self-contained PDF output without outgoing links to other UA deliverables that users can access from the service Product Page and from the Discovery Center Service Catalog.
List only high-level descriptions of product features and describe them in a neutral way.
Use the template as described in the Getting Started section and stick to the sections and outgoing links provided there.

information

It's ok if your service FSD is a short document. It should cover the key features of your service and include "reuse" topics from the central SAP BTP FSD, if applicable to your service.

false

Describe features of the current release completely, not just new features. Only include those committed to by your product owner and tested (100% test coverages and OK rate). Include only those that are officially available (no dark shipments).
Have the product owner, or other responsible person, review and approve your FSD before it's published.
Make sure that the list of features in your FSD is accurate since the list of components in a contract may or may not take precedence over the user assistance.

dont

false

Don’t include service information, including operations details, other than specified in the SAP BTP service FSD template.
Don’t mention any component/service names because components might be renamed or replaced while providing the same capabilities/features in a different way.
Don‘t deliver an interim or incomplete version of the FSD.
Don’t describe features of any another product.
Don’t just delete features from the FSD once it’s published. Once a feature is delivered, it can’t be removed.
The customer has paid for the feature and is entitled to it. It needs to be replaced with a similar, or better functionality.
Don’t mention any apps or transactions.
Don’t describe UI elements or step-by-step procedures.
Don’t make statements about future functions or enhancements.
Don’t document beta features.
Don’t document integration scenarios.
Don't use outgoing links other than specified in the SAP BTP service FSD template.

warning

For more information on Dos and Don'ts, see Feature Scope Description Best Practices.

Getting Started

Familiarize yourself with the FSD Guidelines mentioned above. Consider the Dos and Don'ts.
Collect all your questions and follow up with:
- Your PO for product-related questions (e.g. language, region, browser, certificates availability).
- Sylvia Hördt, if, for example, your questions are process-related, some formulations are not clear, or if you are looking for an example.
- Your CMS Power User, for questions regarding info architecture or output issues.
Use the service FSD template to create your own FSD:
Reuse the topics and content as per the latest version of the template. Evaluate the relevance of the content in the template for your service.
- Only include what is relevant for your service.
- Leave out sections or topics that do not apply for your service.
Reuse the relevant parts from the datasheet for your service.

Setting Up an FSD

Here's how you can quickly set up your service FSD:

1. Describe Features in the Data Sheet

: Describe your features in your data sheetfollowing the guidelines defined in Service Features.

FSD for Job Scheduling service (take a look at the data sheet)
Other service FSDs in the Discovery Center Service Catalog

information

For most of the services, the feature descriptions should be reused from the data sheet, regardless of whether they are part of the central FSD or have their own FSD. However, separately licensed services that cannot describe all of their features in the data sheet, or where the granularity doesn't fit, can extend their descriptions in their own FSD.

How you handle services that are available in both the Neo and the Cloud Foundry environments depends on whether the service shares the same features (from a high-level perspective):

Services that have the same high-level features should document these features in a combined FSD. Avoid mentioning the environments at all, except for the Service Availability chapter, where you can mention the IaaS providers and environments that the service is available in.
Services that offer different features in the Neo and Cloud Foundry environment should create two different FSDs.
The title of the Neo FSD should be "Feature Scope Description for <service> for the Neo Environment" (as aligned with the Neo split metadata changes). The Cloud Foundry title should stay neutral.

Make regional differences transparent. You can refer to your service details page in the Discovery Center Service Catalog.

2. Set Up Your FSD Using the Template

2.1.1 In your project map, check if a PDF rendering for the FSD has already been created.

a. If you are working in the SAP BTP core project map, you can use the available rendering for the central FSD: <PDF for FSD SAP BTP>.

PDF rendering for FSD SAP BTP

b. If you're working in your own project map and haven't created a rendering yet, create the following PDF rendering:

<div> <div>Attribute</div> <div>Value</div> </div> <div> <div>document-security-level</div> <div>Public</div> </div> <div> <div>document-type</div> <div>Feature_Scope_Description</div> </div> <div> <div>hana</div> <div>pdf.sap.coverImage</div> </div>

Your rendering settings are reflected in the cover page of the PDF:

2.1.2. Next, open the buildable map wizard:

2.1.3. Search for the project you want to build your feature scope description with, for example:

2.1.4. Enter your buildable map title in the following format: Feature Scope Description for <Approved service long name>, for example:

2.1.5. Choose your translation languages as required. For most of the SAP BTP services, we do not translate the FSD, but if your service follows a different translation strategy, it also applies to the FSD. In this example, we'll choose "No translation required".

2.1.6. Define outputs for your FSD: Create a PDF output (mandatory), but you can also create an HTML version if you want, for example:

a. Use the rendering from Step 1.

b. Use profiling if you plan to profile your content.

c. Use your product metadata.

2.1.7. Review your settings and confirm.

2.2. Copy the FSD Topics from the Template Buildable Map

information

You can also watch a recording of the following step (from 2:25).

2.2.1. Search for the template buildable map: loio66937a8bcd90463ca510b0a432f7b713 and open it in the DITA map view.

2.2.2. Select all the topics in the map, right-click them and choose "Copy with new LOIO":

2.2.3. Search and select your container and copy the topics.

2.2.4. Open your FSD map in the DITA map view and lock it.

2.2.5. From the Recent Operations view, select your copied topics, and drag and drop then into your locked buildable map:

2.2.6. Update the order of the topics and release the map.

2.3. Replace the Placeholder with Your Data Sheet LOIO

information

You can also watch a recording of the following step (from 5:30).

2.3.1. Open your buildable map in the DITA map view and search for the topics in your buildable map.

2.3.2. Lock your topics.

2.3.3. From the , choose .

2.3.4. Search for LOIO_DATASHEET_TOPIC.

2.3.5. Choose .

2.3.6. Replace with your data sheet loio:

2.3.7. Reload your buildable map in the DITA Map view.

2.3.8. Open the Features topic to check if your datasheet loio has been correctly replaced.

2.3.9. Follow the explanations in the draft-comment. Your first FSD topic is done.

3. Go through the Template Topics

warning

You can access the template here:

https://help.sap.com/viewer/DRAFT/4101ee7db4b64d34b39f1c0b63ce5ab9/Cloud/en-US

Note:

Some sections are duplicated to offer a consistent description for services describing their own UI and services available through the cockpit. Delete the duplicated section as necessary.
Double-check if you need to add a descriptor like "service" to your short name.

The table below explains the purpose of the different topics.

<div> <div>Topic</div> <div>Purpose</div> <div>Template Loio</div> </div> <div> <div>About This Document</div> <div> <ul> <li>Explain the scope of the document</li> <li>Distinguish between the FSD and regular documentation</li> <li>Include a disclaimer about beta features</li> <li>Include a disclaimer about packaging and pricing information and refer to the service catalog</li> </ul> </div> <div>loioc8b0f768a5f84c7b9430a0409f582168</div> </div> <div> <div>Features</div> <div> <ul> <li>Provide a high-level description (service long description)</li> <li>Give an overview of the features</li> <li>Recommended: Reuse features from the data sheet</li> <li>For "complex" services: provide more detailed services descriptions</li> </ul> </div> <div>loioa2a9afffb38a4e22a234443bf8314dd6</div> </div> <div> <div>Service Availability</div> <div> <p>Specify the characteristics of the service in regard to:</p> <ul> <li>Availability</li> <li>Regions</li> <li>Environments</li> <li>IaaS Provider</li> <li>Language</li> <li>Restrictions (to be described in the service guide)</li> </ul> </div> <div>loioc0f922a70551407286ba4d622300eb89</div> </div> <div> <div>Compliance and Security</div> <div> <ul> <li>Main goal: Provide transparency on internal cloud operations processes and create a "bridge" to the Trust Center where this information is stored centrally</li> <li>Certificates and Reports: Services that have been certified should include a reference to their certificates/reports. See <strong>How to figure out if your service is certified</strong> below.</li> <li>Data Centers: Only services that run in SAP centers should refer to data center information (Neo-only)</li> </ul> </div> <div>loio31f8e06d1fde4ff1a78eadb10ce0b869</div> </div> <div> <div>Service Level Agreement</div> <div> <ul> <li>Explain the contractual building blocks of the service</li> <li>Explain which downtimes apply to your service</li> </ul> </div> <div>loio90996c982b694ecc82114851e2f2a630</div> </div> <div> <div>Browser Support</div> <div>Explain the browsers that your service UI supports</div> <div>loiocee8d190a27a4a9793d1854004e6214b</div> </div>

In this example, we'll focus on the certificates, but you can do the same to identify if your service is part of the SOC reports.

3.2.1. In the Certificates and Reports section of the template, follow the ISO Certificates reference (links have been replaced with menu paths for legal reasons):

3.2.2. Type "SAP Business Technology Platform ISO" in the search field to get a reduced results list:

3.2.3. Open one of the PDFs in the view and check if your service is listed (you might have to scroll a bit to get to the list). If your service is listed in one of the reports, keep the related info from the template and refer to the document. Done!

4. Release and Next Steps

Now that you have set everything up, you can:

Publish the PDF output of your FSD.
Publish with your regular takt schedule. You may publish between releases for updates that are not related to the release of new features. This may be rewriting a sentence, implementing feedback on already published content, or adding a link to SLA. Make sure that you do not publish any content related to new unreleased features.
Link to the PDF output of your FSD from your product page.
(Optional) You can also link to HTML output, but PDF is mandatory. If you do not have a product page for your service, link to your FSD from the service-specific overview topic.
Link the PDF from your Data sheet.
Link to your FSD from your datasheet topic to add a link in your service details page in the Discovery Center Service Catalog.
Announce PDF availability.
Communicate that your FSD is available (use social media, inform product management, etc.).
Keep the content up-to-date.
Check on a regular basis that the content is up-to-date and update your FSD as needed. Align with your development team/service owner.

Support

If you have feedback or questions, please contact Sylvia Hördt.

Feature Scope Description Best Practices
About the Central Feature Scope Description
Legal Aspects: User Assistance in the SAP Style Guide for Technical Communication