Consistency Guidelines
      Back to home
      1. Weatherford Knowledge Base
      2. Getting Started
      3. Consistency Guidelines

      Introduction and Best Practices

      Introduction

      The guidelines and conventions stated in the following sections serve the following purposes:
      • They create a consistent look to the workspace, so that everyone working with it can focus on the content.
      • They facilitate copying, changing, sharing, and maintaining the content of the workspace.
      • They demonstrate best practices for working with PetroVisor

      Best Practices

      • be consistent
      • only save data to signals if reused often or the calculation takes a long time (e.g. cumulatives)
      • use placeholders for parameters used in a single workflow, otherwise use workspace values
      • use labels
      • consider different time increments when writing your script (e.g. script should work with daily and monthly scopes)
      • to improve the in-app documentation, items shall be given a concise description adhering to the following guidelines:
        • keep it short and simple (one liner)
        • if the description needs to be more than just one line, format the description using the available options
        • if possible, put links to the knowledge base into the description