Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Service description

Each service in equipme can be described on two different levels: a brief description and a detailed description.

Both serve different purposes and work together to give users the right amount of information at the right time.

Brief description

The brief description is created when a service is added or edited.

It is meant to give a short and clear overview of what the service is and what it is used for. This description appears directly in the service overview and helps users quickly understand the purpose of the service without going into details.

Typical use cases for the brief description are:

  • a short summary of the service

  • the main benefit or use case

  • a high level explanation without technical depth

The brief description should stay concise. It is not intended to list specifications or extensive details.

Detailed description

If you want to provide more in-depth information, you can use the Description tab of the service.

The detailed description allows you to add a structured and comprehensive overview of the service. This is the right place to include additional information such as:

  • technical specifications

  • hardware or software details

  • included components

  • usage notes or limitations

This description can be formatted freely and gives you the flexibility to present information in a clear and readable way.

How descriptions are displayed

In the service view, users will always see the brief description first. This keeps the interface clean and easy to scan.

If a detailed description is available, users can open it by selecting Show detailed description. This allows them to access all relevant information when they need it, without overwhelming the initial view.

This approach ensures that:

  • essential information is always visible

  • detailed information is available on demand

  • services remain easy to understand, even with complex setups

Use the brief description to answer the question: What is this service and why would I use it?

Use the detailed description to answer the question: What exactly is included and how is this service specified?

Separating these two levels helps keep your service portfolio structured and user-friendly, especially as it grows.

Last updated

Was this helpful?