SAP Notes
Deliverables / Support Portal
The main goal of this page is to collect information and best practices that will help you to quickly get started when you are supposed to create SAP Notes. It does not contain BTP specific guidelines.
Introduction
SAP Notes are part of the official SAP documentation. They are documents in standardized form that contain information about SAP products, or instructions about how to handle known errors in SAP systems. SAP Notes offer extended help for customers and SAP employees. Their readability, quality of information, and look and feel influence how the customer perceives and values the quality of our products. Therefore, they must meet certain criteria with regards to quality, credibility, and comprehensiveness.
Depending on its category, an SAP Note may contain information about:
- Errors and insufficiencies in products or documentation, and instructions for correcting them
- Problems within the system environment (operating system, database, frontend, other)
- Workarounds
- Links to Support Packages that solve a problem
- Answers to frequently asked questions
Typically, SAP Notes have their own publishing cycle, which is loosely connected to the product delivery
cycle. Their content has more of a dynamic or short-lived nature.
SAP Notes are restricted to a certain topic and created because of a specific problem. They are used for reactive and preventive measures. SAP Notes may contain applicable prerequisites, interactions, and references to post-processing activities.
Types of SAP Notes
- Security Notes – Contain SAP's expert advice regarding important action items and patches to ensure the security of customer's systems.
- Top Solutions – When a note is very important in the product area and the issue(s) eliminated by the correction may be relevant for other customers.
- HotNews– SAP Notes with Very High priority. They inform customers how to resolve or avoid problems that can cause the SAP system to shut down or lose data.
- Legal Change Notes – Respond to requirements caused by changes in legal regulation.
- Standard Notes – Contain standard replies with general and non-technical information to all customers; they are release-independent.
- SAP Knowledge Base Articles (KBAs) – KBAs can only be created by Product Support while working on a case or incident. KBAs do not contain coding corrections and are incident specific. For more information, see SAP Global Security Incident Reporting.
- Analytics Notification KBA – You can subscribe to high-priority KBAs for Analytics Solutions from SAP. Analytics Notifications are used for Service Packs, Support Packages, Fix Packs, Patches, and Address Directories/Reference Data.
Statuses of SAP Notes
During their creation and maintenance SAP notes can go through the following statuses:
Creating an SAP Note
- Log on to I7P → Notes → Create.
- Templates are SAP notes with prefilled information in some of the note's sections. Certain product areas that frequently release SAP notes have created such templates. You can also create a template of your own. If you want to use a template, select Use Template at the top of your screen:
- Fill in the main SAP Note sections following the instructions below:
Actions with SAP Notes
- Linking SAP Notes
You will probably need to refer to other SAP Notes in the text of your SAP Note. Always link to the actual SAP Note instead of just adding its number as plain text.
You don't need to identify the link to use and then link it manually. Just highlight the number in the text, right-click it, and choose Link as Note.
- Using the Spell Checker
Use ACROLINX IQ as a spellchecker to avoid typos and deprecated terms.
- Using Babelfish
SAP Notes are machine translated. To avoid awkward versions in other languages, you need to mark the terms/phrases/abstracts that you don't want to be translated. To do so, highlight the text and click the No Translation icon.
Best Practices
- Use short, clearly structured, complete, and logically correct sentences
- Use correct spelling and grammar
- Use the ACROLINX IQ to spellcheck SAP Notes
- Use active voice
- Use correct and consistent terminology and standard abbreviations (SAPterm / system entries)
- Write out dates in their long form (for example, March 1, 2012)
- Use the Dual control principle
- Whenever possible use an SAP Note template
- Don't use unclear commands or unclear sentence structures
- Don't use arbitrary abbreviations
- Don't use unnecessary words or capitalization
- Avoid passive voice
- Don't use “please”
Related Links:
Support
If you have feedback or questions, please contact Adriana Daskalova.