Overview
AVAIL provides three complementary ways to give users more context around a content item: Preview, Notes, and Related Content. Although these features may sometimes surface similar information, each is intended to serve a distinct purpose.
Use Preview to show another representation of the same content item, such as an image, model view, or generated PDF. It helps users inspect the content without opening the source file.
Use Notes to provide information about the content, such as instructions, standards, warnings, training resources, product webpages, or links to external documentation.
Use Related Content to connect separate content items that are meaningfully associated. These related items have value on their own and may be independently viewed, downloaded, loaded, or reused.
Simple rule:
Preview shows it. Notes explain it. Related Content connects it.
A Simple Decision Framework
When deciding which feature to use, ask the following questions in order.
1. Is it another representation of the same content?
Examples include a generated image, thumbnail, or vector-based PDF of a Revit detail.
Use Preview.
2. Is it explanatory, instructional, or reference information about the content?
Examples include an SOP, product webpage, training video, firm standard, or usage instruction.
Use Notes.
3. Is it a separate content item that can be independently discovered or used?
Examples include a detail contained on a sheet, a component used within an assembly, or a family associated with a drafting view.
Use Related Content.
Comparison at a Glance
|
Feature |
Primary Purpose |
What It Represents |
Typical User Action |
|
Preview |
See the content |
A visual representation of the same content item |
Inspect, zoom, print, or save |
|
Notes |
Understand the content |
Information, guidance, or references about the content |
Read, learn, verify, or follow a link |
|
Related Content |
Explore connected content |
Separate but meaningfully associated content items |
Navigate, discover, load, download, or reuse |
Guidance for Existing Related Content
Because Related Content was available before Notes, some firms may currently use Related Content for links or reference information that would now be better represented as Notes.
This does not mean those existing relationships are invalid. However, firms may benefit from reviewing them using the following distinction:
- If the linked item is a separate asset users may want to discover, manage, or reuse, retain it as Related Content.
- If the linked item primarily explains the content or directs users to supporting information, consider converting it to a Note.
- If the resource serves both purposes, it may be appropriate to maintain it as Related Content and add a Note that explains the relationship or provides usage guidance.
The goal is not to force every connection into a single category. The goal is to make the user experience predictable.
Users should learn that:
- Preview is where they look to see the content.
- Notes are where they look for guidance, explanation, and reference information.
- Related Content is where they look for other connected content.