stepworks

English

Français
Español

English

Français
Español

Appearance

Getting Started ​

Creating an Account ​

  1. Go to https://app.stepworks.fr/sign-up
  2. Complete the form.
  3. Click Sign Up.
  4. Check your email for a verification link. Click the link to verify your account and log in to StepWorks.

Logging In ​

  1. Go to https://app.stepworks.fr
  2. Enter the email address associated with your account.
  3. Enter the password.
  4. Click Sign In.

Adding a Product ​

Follow these steps to add a new product in StepWorks:

  1. Log in to your account at app.stepworks.fr.

  2. Navigate to your Products page and click + Add Product.

  3. Enter your Product Name.

  4. Upload your 3D model file. Supported formats include:

    • OBJ, FBX, GLB, GLTF, USDZ, STP (beta), STEP (beta)
    • If your product does not have a 3D model, toggle the 3D model option to off

  5. Upload your product documentation (optional). Supported formats include:

    • PDF, TXT, DOCX
    • If you do not have product documentation, toggle the Documentation option to off

  6. Use the preview window to set the product thumbnail. This image will appear on your product page.

  7. Click Create to finalize and add your product.

Your new product will appear in your product list. After initial rendering is complete, you can further configure your Product Twin.

Configuring the Product Twin ​

Configuring a Product Twin allows you to define how different parts of your product behave in various states. This is essential for creating realistic and interactive procedures such as assembly instructions, maintenance guides, or troubleshooting steps.

Reference Name ​

Each part in the Product Twin has a Reference Name by default, which is inherited from the part name in the original 3D CAD file.

Note: This name can be edited within StepWorks. For best results when using automatic procedure generation, the reference name should match how the part is described in your product documentation (e.g., "Control Panel", "Battery Cover"). This improves StepWorks' ability to correctly identify and link parts to relevant steps in the generated procedure.

Default Part States ​

Each part in a Product Twin has a set of default states:

  • Default: The standard appearance of the part with no modifications.
  • Hidden: The part is invisible.
  • Disassembled: The part appears removed or separated from its assembled position.

These states can be used to visually represent different phases in a procedure.

Custom Part States ​

In addition to default states, you can create custom states to represent specific conditions such as:

  • Open/Closed positions
  • Locked/Unlocked components
  • Any other meaningful configuration relevant to your product

How to Add States ​

  1. Open the Product Twin editor for the product you want to modify.
  2. Select a part from the model.
  3. Click + Add State.
  4. Define the state name (e.g. “Closed”, “Unlocked”) and apply the corresponding transformation or visibility to the part.
  5. Click Add to save the state.
  6. Repeat for additional states or parts as needed.
  7. Save your changes.

Once configured, these states will be available when creating or editing steps in your scenarios.

By properly configuring part states—and assigning clear reference names—you improve the instructional quality and generation accuracy of your StepWorks scenarios.

Creating a New Procedure ​

  1. Open the product for which you want to add a procedure.
  2. Click + New Scenario (Procedure).
  3. Enter a Name for the procedure.
  4. Select the Language in which the procedure will be written.
  5. Choose a creation method:
    • Create: Build each step yourself using the editor.
    • Generate: StepWorks will generate steps based on the uploaded product documentation.

Adding and Editing Steps ​

When adding or editing steps, you can:

  • Set Camera Viewpoint: Define the initial orientation, zoom level, and angle of the product for the step. Users can adjust the camera freely during playback, but they will first see the product as positioned in the configured viewpoint.
  • Add Media: Upload contextual images to provide additional clarity. This can include references to external tools, packaging, body positioning, or surrounding environments.
  • Assign Parts: Link one or more parts to a step.
  • Set States: Apply defined states (e.g., Default, Hidden, Disassembled, Open, Closed).
  • Add Animations: Define how the part moves, appears, or changes during the step.

These settings help visually communicate each stage of the procedure in an intuitive, 3D format.

Once your steps are complete, you can preview the scenario and publish it when ready. For details, see Publishing a Procedure.

Inviting Colleagues ​

Follow these steps to invite members to your StepWorks organization:

  1. Log in to your StepWorks account at app.stepworks.fr.
  2. Navigate to the Organization section from the menu.
  3. Click + Add Member.
  4. Enter the new member's information:
    • First Name
    • Family Name
    • Email Address
  5. Select the appropriate Role for the new member:
    • Viewer: Can view products, scenarios, and documentation, but cannot make changes or edits.
    • Editor: Can create, edit, and manage products, scenarios, and documentation.
  6. Click Add Member to send an invitation email to the new member.

The invited member will receive an email containing a link to create their StepWorks account and join your organization.