Points, Map Points, and Frame Groups
Points are how UiGraph turns a static screen or diagram into navigable engineering context.
Use them to connect a specific region of a frame to:
- APIs, services, databases, and tests
- another map for drill-down navigation
- a group of nested frame variants inside the same screen
Point types
- Implementation points connect a region to engineering artifacts.
- Map points connect a region to another map.
- Frame group points define a nested area that can contain multiple subframes or states.
How this fits together
- A map groups related frames around a feature or workflow.
- A frame is a screen, mockup, or diagram inside that map.
- A point anchors context to a meaningful part of the frame.
Map points
Map points are best when a screen should lead readers into another feature area or subflow.
Common uses:
- Move from a dashboard view to a detailed workflow map
- Jump from a parent screen to an admin or settings flow
- Show how users navigate between related experiences
When used well, map points make the documentation path follow the product path.
Frame group points
Frame group points are useful when one region of a screen contains multiple states or variants.
Examples:
- Checkout card with desktop and mobile variants
- Modal area with loading, success, and error states
- Admin panel where tabs share layout but differ in implementation details
Each subframe can keep its own points while still belonging to one grouped region.
Working model
For a clean documentation system:
- Start with the user-facing frame.
- Add implementation points for APIs, services, and data stores.
- Add map points where a reader should navigate deeper.
- Use frame groups only when a region truly has multiple meaningful states.
Recommended usage
- Use short, descriptive point labels.
- Link to stable downstream maps and artifacts.
- Keep grouped variants focused on one bounded region of a frame.
- Avoid overloading a single frame with too many point types at once.