Draw a system diagram

Author The Listener Topic Bassilisk First published Last updated 3 min read

Suggest a correction

Use your build's system diagram to place parts as nodes and show their connections. Check the ports and connection details, then save the diagram and submit it with the build for review.

Before you start

Save your build, then open its diagram editor while signed in as the author. Editing requires a larger screen. Readers can still view the public diagram on mobile.

Gather the parts and connection details you want to show. A node represents a component in this build. Ports identify where connections begin and end. The diagram stores the arrangement and wiring details alongside your build's parts.

Steps

  1. Use Add part to add a component to the build. Find it under Parts in this build, then choose Place on diagram. Place each instance you need; the available quantity limits how many instances you can place.
  2. If the part only belongs to this project, choose One-off component in the component picker. Enter its name, part type and quantity, then add it to the build. It stays local to this build and does not enter the parts-library review queue.
  3. Position the nodes so the route through the system is easy to follow. Use Add ground node or Add power source node where needed. Arrange diagram helps organise the layout; Fit to screen brings the diagram into view.
  4. Inspect the ports before drawing connections. Hollow markers are inputs; filled markers are outputs. Component-linked ports come from the component and are read-only in the diagram. Use Refresh from component after updating the component's ports, then check the result.
  5. Choose Connect nodes. Select an output or bidirectional port, then a compatible receiving port on the destination. The editor rejects ports that cannot start or receive that connection. Check the selected endpoints if a connection fails.
  6. Select a connection to inspect its purpose, medium, interface and direction. Defaults can come from the ports, but check that they describe your actual connection. Add relevant details such as cable gauge, length, fuse rating, channels or protocol. These describe this build's connection.
  7. Choose Save. When the build is ready, choose Submit for review. The diagram is included with the build submission. Use Publish your build for the review and revision workflow.

What happens next

The public diagram uses the approved build revision. Saving your work prepares it for review; an existing public diagram stays on the approved version until the replacement is approved.

Open Diagram key to read the connection styles. The kinds cover power, ground, control, speaker audio, analog audio, digital audio, data or network, and custom connections. Their different colours help readers follow a run through crossings. Stroke widths also differ.

The line colour describes the connection's purpose. Record the physical wire colour in the connection details when it matters. Solid lines indicate cables, dashed lines indicate wireless connections, and dotted lines indicate logical connections. Direction and interface add information that colour alone cannot convey.

Common mistakes

  • Expecting every part to appear automatically. Add the part to the build, then place its node on the canvas.
  • Trying to edit a component-linked port in the diagram. Update the component and refresh its ports instead.
  • Leaving an inferred connection purpose unchecked. A readable drawing still needs the correct endpoints, medium and wiring details.
  • Expecting a saved diagram to appear publicly before the build revision is approved.

First published

Last updated

The author maintains this document. Contributors can suggest corrections.

Discussion

No linked discussion yet. Ask a question or add context from your own work.