Procedures

A Procedure is the step-by-step experience executed in StepWorks. Procedures are created from Product Home and edited in the Procedure Editor.

The current workflow supports:

• blank procedures
• generated procedures from product documents
• generated procedures from 3D + voice recording
• generated procedures from video
• batch-generated procedures from suggested document analysis

Procedure Types

The create dialog currently supports:

• Assembly
• Disassembly
• Maintenance
• Usage
• Quality Control

Create One Procedure

Step by step

Create a blank or generated procedure

Use Single procedure when you want one procedure only.

Product HomeProceduresCreate procedureSingle procedure

Steps

1. In the procedures table, click Create procedure.
2. Choose Single procedure.
3. Enter Procedure Name.
4. Choose the Type.
5. Choose the authoring Language.
6. Click Create for a blank procedure.
7. Click 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 manual already explains the filter replacement workflow.

Result

The procedure appears in the table. Generated procedures may remain in Pending while StepWorks creates the draft.

Screenshot

Single procedure dialog

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

Create Several Procedures From Manuals

Step by step

Use Batch create from product documents

Use Batch create when you want StepWorks to scaffold several procedures at once.

Product HomeProceduresCreate procedureBatch create

Steps

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

Example

A service manual might suggest Install battery, Charge battery, and Replace battery. Remove any duplicates or titles that are too broad before you generate them.

Screenshot

Suggested Procedures dialog

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

Understand Procedure Status

The procedures table can currently show:

• Pending
• Failed - Click to retry
• Published
• Unpublished

Use the table to:

• search procedures
• sort by name, date, type, and status
• open a procedure
• copy a link
• duplicate, rename, or delete a procedure

Screenshot

Procedures table in Product Home

The procedures table includes status badges, the Create procedure menu, and row actions such as rename, duplicate, and delete.

Edit A Procedure

Step by step

Work in the Procedure Editor

The editor is where you review generated drafts and refine the final user experience.

Product HomeOpen a procedureProcedure Editor

Steps

1. Open the procedure from the procedures table.
2. Update the procedure name if needed.
3. Confirm the procedure type.
4. Edit the steps.
5. Save manually from the header.
6. Review the full flow before you publish it.

Example

If a generated procedure creates five steps but the real workflow needs seven, add the missing steps before you publish.

Screenshot

Procedure Editor

The Procedure Editor keeps the 3D view, the step list, and the current step content in one authoring workspace.

Record A Procedure Draft

Recording in the Procedure Editor is separate from the Add video option in the create dialog. Use the editor recorder when you want StepWorks to build a draft from live narration with part selections or from a continuous camera recording.

The record menu currently offers:

• Start 3D + Voice recording for microphone audio plus timed part or group selections
• Start video recording for camera and microphone capture with a live preview and boundary markers
• More details for the built-in help dialog

Step by step

Use 3D + Voice recording

Use this mode when you want to describe the workflow while selecting the related parts or groups.

Procedure EditorRecord menuStart 3D + Voice recording

Steps

1. Open the procedure in Procedure Editor.
2. In the lower-right corner of the step panel, click the black record button.
3. Choose Start 3D + Voice recording.
4. Allow microphone access if your browser asks.
5. Describe the workflow naturally while selecting parts or groups in the 3D view or the assembly hierarchy.
6. Use phrases such as in the next step when you want clearer step separation.
7. Click the red stop button when you finish, or Cancel if you want to discard the take.

Example

Say Remove the battery cover. In the next step, disconnect the battery cable. while selecting Battery Cover and then Battery Cable.

Result

StepWorks uploads the audio plus your timed selections and generates an editable draft.

Screenshot

3D + Voice recording in the record menu

The record menu includes the Start 3D + Voice recording option.

Step by step

Use video recording

Use this mode when you want to capture one continuous demonstration inside the editor.

Procedure EditorRecord menuStart video recording

Steps

1. Open the procedure in Procedure Editor.
2. Click the black record button and choose Start video recording.
3. Allow camera and microphone access if your browser asks.
4. Record one continuous take. The editor shows a live preview while recording.
5. Click Mark step boundary whenever one step ends and the next begins.
6. Use Undo marker if you need to remove the latest boundary.
7. Click the red stop button to process the recording, or Cancel to discard it.

Example

Record the full filter replacement from removal to reassembly and add a boundary each time the operator moves to a new action.

Result

StepWorks uploads the recording for processing and returns an editable draft that should still be reviewed before publication.

Screenshot

Video recording in the record menu

The record menu includes the Start video recording option.

While a recording is active, StepWorks disables normal step editing and add-step controls until you stop or cancel the current take. For browser permissions, see Technical Requirements.

Use The Editor Assistant

Step by step

Use the Editor Assistant to refine a procedure

Use the assistant while authoring when you want help inserting, updating, deleting, or reordering steps. You must be signed in and inside an existing procedure.

Procedure EditorLeft railAssistant

Steps

1. Open the procedure in Procedure Editor.
2. In the left rail, click the black Assistant button with the Tina icon.
3. Ask for the change you want, such as adding a missing step or rewriting a step description.
4. Review the assistant response and any citations it returns.
5. If the assistant proposes tool actions, approve only the edits you want to apply.
6. Review the updated steps in the editor and click Save.

Example

Ask: Insert a safety step before battery removal and rewrite the next step so it tells the operator to disconnect power first.

Result

The approved edits are applied to the current procedure and remain editable before publication.

Screenshot

Editor Assistant panel

The left rail includes the black Tina button, the open chat panel, and the approval checklist for tool actions.

Work With Steps

In the current data model, each step can include:

• title and description
• linked parts
• part states
• camera viewpoint
• supporting images or video
• annotations and visual cues when your workflow uses them

Generated procedures should always be reviewed before publication.

Publish From The Editor

Step by step

Quick publish one procedure

Use quick publish for a single procedure when the product-level publish setup is already correct.

Procedure EditorPublishing

Steps

1. In the editor header, click Publishing.
2. Turn on Public, Private, or both.
3. Save the publish change.
4. If the procedure is published, use Share when you need a link or QR code.

Example

If Replace Air Filter should only be used by internal technicians, publish it as Private only.

Screenshot

Procedure Editor header

Save, Publishing, Share, and Export stay in the editor header so authors can publish without leaving the procedure.

If you need to change languages, reporting, branding, or the published procedure set for the whole product, go to Publishing Settings.

Share And Export

Once a procedure is published, the current workflow also exposes:

• Share for public/private links, QR download, and embed code where available
• Export for PDF and Word output

Step by step

Share a published procedure

Use Share when you need a link, QR code, or embed option for one published procedure.

Procedure EditorHeaderShare

Steps

1. Open the published procedure in Procedure Editor.
2. In the editor header, click Share.
3. Copy the public or private link you need.
4. Download the QR code or use the embed option if it is available in your workspace.

Example

Copy the private link for internal technicians, or download the QR code so the procedure can be opened on the shop floor.

Screenshot

Share action in the Procedure Editor

The editor header includes the Share action.

Step by step

Export one procedure from the editor

Use Export when you need PDF or Word output for the current procedure.

Procedure EditorHeaderExport

Steps

1. Open the published procedure in Procedure Editor.
2. In the editor header, click Export.
3. Choose the export format you need.
4. Wait for StepWorks to generate the file before sharing it elsewhere.

Example

Export a PDF when a technician needs a printable version, or export Word when the content must be reviewed and edited outside StepWorks.

Screenshot

Export action in the Procedure Editor

The editor header includes the Export action.