Rebranded products or features
Use the following guidelines to refer to products, features, or packages that have changed names. Which approach you use depends on whether the documentation has also changed locations.
Rebranded products with no documentation moves
When you document products and features that have been rebranded without changing the documentation location, you don't need to add a banner to the top of the page or documentation set.
On first mention on the documentation landing page, use both the old and new names. For example, "The Mecanim Animation system, previously called the Unity Animation system..."
In subsequent references, use only the new name. Maintain consistency throughout the documentation set to avoid confusion.
Rebranded products where the documentation has moved
When the documentation for a rebranded product or feature has moved to a new location, then you need to add a note banner to the top of the relevant page in the previous location:
- For rebranded features or APIs, add the banner to the specific page for that feature or API.
- For rebranded products, add the banner to the top of the front page of the documentation set.
Include the following information in the note banner:
- The status of the feature. Avoid using time-sensitive language to refer to the future state of the feature.
- A link to the new location where the documentation can be found.
- A reminder to update the user's bookmarks and references.
Use the following template:
<Product, feature, or package name>is now called<new product or feature name>. For the latest updates and guidance, visit thenew product or feature namedocumentation. Make sure to update your bookmarks and references accordingly.
| Example note banner |
|---|
| Note: Sentis is now called Inference Engine. For the latest updates and guidance, visit the Inference Engine documentation. Make sure to update your bookmarks and references accordingly. |
For information about how to add banners to package pages, refer to Add message banners to every page.