Getting Started with SOP Studio
SOP Studio is a visual editor for building Standard Operating Procedures (SOPs) that can be published to the KnowledgePulse registry as ExpertSOP knowledge units. It provides a drag-and-drop canvas, document import with LLM extraction, and real-time collaboration.
Prerequisites
- A running KnowledgePulse Registry instance (local or remote)
- An API key with
writescope (see Authentication)
Configuration
Set the following environment variables before launching SOP Studio:
export KP_REGISTRY_URL="http://localhost:3000"
export KP_API_KEY="kp_your_api_key_here"
Alternatively, configure these in the SOP Studio settings panel after launch.
Launching SOP Studio
Start the SOP Studio development server:
cd packages/sop-studio
bun run dev
The studio opens at http://localhost:5173 by default.
Creating Your First SOP
- New SOP -- Click the "New SOP" button in the top toolbar.
- Set metadata -- Provide a name, domain, and description in the properties panel on the right.
- Add steps -- Drag Step nodes from the palette onto the canvas. Each step has an instruction field and optional criteria.
- Add conditions -- Use Condition nodes to create branching logic (e.g., "If severity is high, escalate").
- Connect nodes -- Draw edges between nodes to define the flow.
- Save -- Press
Ctrl+Sor click "Save" to persist the SOP to the registry.
SOP Metadata Fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Human-readable SOP name |
domain | string | Yes | Task domain (e.g., customer-support) |
description | string | No | Brief summary of the SOP |
visibility | string | Yes | private, org, or network |
tags | string[] | No | Searchable tags |
Example: Minimal SOP
{
"name": "Bug Triage",
"domain": "engineering",
"visibility": "org",
"decision_tree": [
{
"step": "classify",
"instruction": "Classify the bug by severity",
"conditions": {
"critical": { "action": "Escalate to on-call", "sla_min": 15 },
"major": { "action": "Assign to sprint", "sla_min": 60 },
"minor": { "action": "Add to backlog" }
}
}
]
}
Next Steps
- Decision Tree Editor -- Learn about node types and the visual canvas
- Document Import -- Import existing SOPs from DOCX or PDF
- Collaboration -- Invite teammates to edit in real time