How to add a system description
A system description says what a technical system does and how it's put together. It's often the difference between a system number that tells you nothing and an installation somebody can get to grips with.
How to add a system description
- Open the building you want to work on. See How to switch building and search for a building.
- Go to FDV > Building overview in the sidebar.
- Find the system under Systems.
- Click Add description.
- Write the description.
- Click Save.
You get the confirmation System description saved. Below the description it says Updated by {user} · {date}, so it's traceable who wrote what and when.
How to change or delete the description
- Open the description, edit it and click Save.
- To remove it, delete it and confirm Delete the system description?
If saving fails, the message says Couldn't save system description.
What's worth writing
A system description is technical documentation, not an operations log. What makes it useful:
- What the system serves — which zones, rooms or functions
- How it's built — the main components and how they connect
- How it's meant to be controlled — setpoints, operating hours, the principle
- What's unusual about it — departures from the standard solution, known limitations
Ongoing observations and events don't belong here — those go under Operational information. See How to add operational information to a system.
The difference between a system description and operational information
System description | Operational information | |
|---|---|---|
Content | how the system is | what happens to it |
Changes | rarely, on rebuilds | continuously |
One or many | one per system | several notes |
Note: The description belongs to the building, not to you. Everyone with access sees it, and everyone with write access can change it — which is why Updated by is worth checking if the content looks out of date.
Frequently asked questions
Can I paste in a description from the FDV documentation?
Yes, and that's often the quickest route. Consider trimming it to what's relevant for operations — a description nobody reads doesn't help.
Should I write a description for every system?
Start with the systems that produce incidents or that are complicated. Systems nobody has problems with can wait.
Where does the description become visible?
On the system in the FDV building overview.
Who can add descriptions?
Anyone with write access to the building.
Tip!
Write the description with the person called out on a Sunday in mind, who has never seen the installation. They can find the system number and component list themselves — what they're missing is what the installation is supposed to do.