General rules
Use sentence case and end with a period (similar to tooltips).
- View the current status of the production line.
- VIEW CURRENT STATUS OF PRODUCTION LINE
Use infotips to support users with guidance and contextual information.
- Maximum allowable hydraulic pressure (bar).
- Current motor load in percentage.
- Enables automatic system recalibration.
- Unique identifier for the production batch.
Use infotips to help users understand complex terminology.
- SCADA System
Supervisory Control and Data Acquisition: A system that monitors and controls industrial processes locally or at remote locations. - PLC cycle time
This indicates the time (in milliseconds) it takes for the Programmable Logic Controller to execute one full scan of its program logic.
Use infotips to help users understand complex features and workflows.
- Set thresholds
Set project thresholds here. Adjust the value to trigger alerts when the temperature exceeds a specified limit (e.g. 80°C). - PID controller tuning
Adjust these parameters (Proportional, Integral, Derivative) to optimize the system's response to errors and achieve stable control. - Schedule maintenance
This workflow guides you through planning and assigning preventive maintenance tasks. First, select the asset, then define the task type, and finally set the recurrence schedule.
Use paragraphs to split complex information and use bullet points or lists for clarity.
- Power meter monitoring
Area: Production floor
Present consumption: 120 kW
Peak: 150 kW
Button: Open meter list
Use imperative verbs (commands) for instructions and guidance.
- Assign a unique identifier to each physical asset for tracking, maintenance scheduling, and inventory management.
- Define and manage sequences of operations and ingredient quantities for automated production processes.
Avoid personal pronouns (you, we, our, etc.).
- Select a device from the network to begin configuration.
- Select one of your devices to begin configuring your factory assets.
Dos and Don’ts
- Do keep infotips short and instructional
- Don’t include critical or legal information
- Don’t copy your user manual into your infotips