Getting Started

Use this page as the first-run checklist for the current StepWorks workflow.

1. Sign In And Open The Correct Workspace

Step by step

Open the editor workspace

Choose the right organization before you create or edit anything.

Top barOrganization switcherProducts

Steps

1. Go to https://app.stepworks.fr.
2. Sign in or create an account.
3. In the top bar, open the organization switcher.
4. Select the organization you want to work in.
5. If that organization gives you Editor access, continue on Products.
6. If that organization gives you Viewer access only, StepWorks opens the viewer-side product list instead.

Example

If you belong to both Viewer Demo Org and ACME Assembly, choose ACME Assembly before you start product setup. Otherwise you may land in the viewer workflow instead of the editor workflow.

Result

You are on the Products page and ready to create or open a product.

Screenshot

Sign-in page and organization switcher

Sign in first, then confirm that you are inside the correct organization before you start product setup.

2. Create Your First Product

Step by step

Create a product with a model and optional manuals

A product is the container for the 3D model, instruction documents, procedures, publishing settings, and QR workflows.

ProductsNew Product

Steps

1. Open Products.
2. Click New Product.
3. Enter a Product Name.
4. Turn on 3D model if this product needs a Product Twin.
5. Upload the model file. The current UI accepts OBJ, FBX, GLB, GLTF, USDZ, USD, USDA, STP (beta), and STEP (beta).
6. Turn on Instructions if you want AI-assisted procedure generation.
7. Upload one or more instruction files in PDF format.
8. Click Create.
9. Wait for processing to finish before opening the product.

Example

Create Cordless Drill X200, upload drill.glb, and attach x200-service-manual.pdf. This gives you both a Product Twin workflow and document-based procedure generation later.

Result

The product appears in Products and becomes ready after processing completes.

Screenshot

New Product modal

The New Product modal combines the product name, 3D model upload, instruction upload, and Create action.

3. Open Product Home

Step by step

Use Product Home as the control center

Product Home is the handoff point between model setup, documents, procedures, publishing, and QR settings.

ProductsOpen a productProduct Home

Steps

1. Open the product from Products.
2. Use Product Twin when you need to prepare the 3D model.
3. Use Product Document when you need to add or replace manuals.
4. Use Publish Settings when you need to choose public/private procedures, languages, reporting, or branding.
5. Use Product Settings when you need viewer links, QR codes, or serial-number workflows.
6. Use the procedures table at the bottom when you need to create or edit procedures.

Example

If the 3D model is ready but the PDF manual is missing, go to Product Document first. If the manual is already in place and you want a first draft procedure, stay in the procedures table instead.

Screenshot

Product Home

Product Home combines the top action bar, the 3D product view, and the procedures table.

4. Prepare The Product Twin

Step by step

Set up the 3D model for procedure authoring

Reference names are optional. What matters most is that the Product Twin behaves like the real object before you start authoring procedures.

Product HomeProduct Twin

Steps

1. In Product Home, click Product Twin.
2. Select an important part in the hierarchy.
3. Set a Reference Name only if the default part name is not clear enough.
4. Add a Store Link if viewers may need to reorder or replace that part.
5. Create or edit the part states you need so the Product Twin behaves like the real object.
6. Save your changes before returning to Product Home.

Example

Rename a part from Part_27 to Battery Cover, add a store link to the spare part page, and create an Open state if the cover needs to move during the procedure.

Result

Your procedures can now reference clearer parts, and a realistic Product Twin will help generation a lot.

Screenshot

Product Twin in Product Home

The top action bar includes Product Twin.

Screenshot

Product Twin editor

The Product Twin editor shows the part hierarchy on the left and the inspector for names, links, and states on the right.

5. Create Procedures

Step by step

Create one procedure

Use Single procedure when you want one procedure only, whether it is blank or generated.

Product HomeProceduresCreate procedureSingle procedure

Steps

1. In the procedures table, click Create procedure.
2. Choose Single procedure.
3. Enter a Procedure Name.
4. Choose the Type.
5. Choose the authoring Language.
6. Use Create for a blank procedure.
7. Use Generate if the product already has instruction documents.
8. If you want to generate from video, turn on Add video, upload the video, and then click Generate.

Example

Create Replace Air Filter, choose Maintenance, choose English, and click Generate if the product already has the maintenance PDF.

Result

The procedure appears in the table. Generated procedures may stay in Pending while StepWorks finishes the draft.

Screenshot

Single procedure dialog

The Single procedure dialog includes Procedure Name, Type, Language, Add video, Create, and Generate.

Step by step

Create several procedures from manuals

Use Batch create when you want several procedure drafts from the product documents.

Product HomeProceduresCreate procedureBatch create

Steps

1. In the procedures table, click Create procedure.
2. Choose Batch create.
3. Wait for StepWorks to analyze the product documents.
4. Review the suggested procedure titles and types.
5. Edit or remove any suggestion that is not useful.
6. Click Generate Procedures.

Example

A product manual may produce suggestions such as Install battery, Charge battery, and Replace battery. Remove any suggestion that does not belong in the final workflow before you generate them.

Screenshot

Suggested Procedures dialog

The Suggested Procedures dialog includes editable titles and types plus the Generate Procedures action.

6. Publish And Share

Step by step

Quick publish from the Procedure Editor

Use the quick publish flow when you only need to expose one procedure.

Procedure EditorPublishing

Steps

1. Open the procedure from the procedures table.
2. In the editor header, click Publishing.
3. Turn on Public, Private, or both.
4. Save the publish change.
5. If the procedure is published, use Share to copy a link or download a QR code where your plan allows it.

Example

If Replace Air Filter should only be used internally, turn on Private only and leave Public off.

Screenshot

Procedure Editor header

The Procedure Editor keeps save, publishing, share, and export actions in the top bar next to the 3D view.

Step by step

Use Publish Settings for product-level publishing

Use the full page when you also need languages, reporting, branding, or a controlled public/private procedure list.

Product HomePublish Settings

Steps

1. Go back to Product Home.
2. Click Publish Settings.
3. Open the Public or Private tab.
4. Choose which procedures should be available in that tab.
5. Update languages and viewer options if needed.
6. Click Save.

Example

Publish Install Battery publicly in English and French, but keep Replace Internal Fuse private with reporting enabled.

Screenshot

Publish Settings page

Publish Settings keeps the Public and Private tabs, the procedure list, viewer options, and Save on one screen.

7. Use Product Settings For QR And Serial Workflows

Step by step

Prepare a viewer link or QR code

Product Settings is for product-level sharing, QR download, serial registration, and serial-number-based viewing.

Product HomeProduct Settings

Steps

1. In Product Home, click Product Settings.
2. Choose Public or Private.
3. Copy the product viewer link if you need a direct URL.
4. Download the product QR code if you need a scannable entry point.
5. Import or generate serial numbers if each unit needs its own QR workflow.
6. Export the ZIP of serial-specific QR codes once the serial list is ready.

Example

If 200 physical units need unique traceability, generate or import serial numbers first, then export the ZIP of serial-specific QR codes.

Result

Each serial-specific QR opens the same product viewer with the serial number already embedded in the URL. Reporting and report history can then stay attached to that exact physical unit.

Screenshot

Product Settings in Product Home

The top action bar includes Product Settings.

Screenshot

Product Settings page

Product Settings combines the product QR, viewer link, serial-number registration, and serial-specific QR export tools.

8. Keep The Workspace Running

After publishing:

• Use Organization to manage members and export templates.
• Use Dashboard to review product and procedure analytics.