Documenting your Workers

Managing documentation for your team’s workers is effortless with the Comment and Description fields in zSYNC.

Every worker in zSYNC comes equipped with these fields, allowing your team to store relevant notes directly within the worker itself. This integration helps maintain continuity and prevents data loss, especially when multiple people are involved in maintaining pipelines. No more hunting through external platforms or scattered documents to find crucial worker-specific information.

Use the Comment field to capture insights like:

• “I know this looks strange, but this worker is necessary because…”

• “⚠️ Keep deactivated until AFTER the deployment on 5th April 2025!”

The Description field can store essential documentation, such as:

• “This worker fetches all sales orders modified since the last pipeline run.”

• “Worker details: https://docs.mycompany.com/pipeline/2/worker/4”

By keeping documentation within the worker itself, your team can reduce effort, minimise mistakes, and make future maintenance smoother.