Document Conventions:conv
Feature Grades Foundation
This documentation uses a color scheme for classifying the current grade of the various product features. A feature can be a command, function, method, class, operator or a chapter in the programming guide.
Each feature is classified regarding its overall grade which covers implementation, automated validation/verification as well as sample and documentation status. The resulting feature grade is denoted by color codes which are applied to the header section of the page documenting the respective feature. The following sections show all available color codes.
Feature States "Blue" and "Green"
Feature States "Orange" and "Red"
The color codes outlined above have the following meanings:
Blue: The feature is usable without restrictions.
Green: The feature is safe to be used in production. However, the documentation may be incomplete or the sample code is missing.
Orange: The feature may be used in production and for developing new code. The interfaces are stable and future changes are not likely. However, some capabilities may be broken or do not behave as documented. The documentation is incomplete but correct.
Red: Usage of the feature in production environments implies some risks. The feature is a work in progress and its interfaces or behavior may change in future updates. The documentation may be incomplete or wrong.
This classification scheme allows developers to decide whether a certain feature is safe to be used in a given context. For example, a certain feature may be perfectly usable for a certain use-case, even though its documentation has not been finalized. Similarly, the risk of future behavioral changes may be acceptable under specific circumstances.
Feedback
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.