Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.steppd.com/llms.txt

Use this file to discover all available pages before exploring further.

Every piece of process knowledge in Steppd lives as a document. Documents move through a defined lifecycle, from a working draft to a published entry in your active process library, and eventually to an archive, and are built from a consistent hierarchy of sections, steps, and sub-steps. Understanding this model helps you create content that is structured, discoverable, and ready to deploy wherever your team needs it.

Document statuses

A document always carries one of two active statuses. The status controls who can see it, what actions are available, and how it behaves in your library. Documents can also be archived, removing them from the active library.

Draft

A work in progress. Only visible to your team inside the app. Drafts can be edited by the document owner and any assigned co-author. A revision draft is a special draft that is linked to the published document it will replace.

Published

The active, authoritative version. Ready to be exported, embedded, or distributed via webhooks. Publishing a draft promotes it into your active process library.
Only drafts and published documents appear in your My documents list. Archived documents are moved to Archives, accessible from the sidebar.

Document structure

Every document is built from a small set of metadata fields and a three-level content hierarchy.

Metadata

FieldRequiredDescription
TitleYesThe name of the document as it appears in your library.
VersionNoA free-text label such as 1.0 or v2. Used to distinguish revisions and track change history.
DepartmentNoAn optional grouping tag. Admins create departments under Settings → Organization.

Content hierarchy

Documents are composed of nodes arranged in a three-level tree:
1

Sections

Top-level groupings within a document. A section might represent a phase, a role’s responsibilities, or a major topic within the process. Every document has at least one section.
2

Steps

The individual actions or tasks that make up a section. Each step belongs to exactly one section and can contain rich text content.
3

Sub-steps

Optional detail beneath a step. Use sub-steps when a single action needs to be broken down into smaller sequential tasks.
Each node, section, step, and sub-step, has its own title and rich text content area, both editable in the Steppd editor.

Authors and ownership

Every document tracks two people-related fields:
  • Owner, the person who created the document, or the person ownership has been reassigned to. The owner can edit the draft, publish it, archive it, and delete it.
  • Co-author, an optional assigned collaborator who can also edit the draft. Each document supports one co-author at a time.
Admins can reassign ownership or change the co-author at any time using the action menu on the document list.

Available actions

The actions available on a document depend on its current status.
ActionDescription
EditOpen the editor to update content, title, version, or department.
PublishPromote the draft to published status and add it to your process library.
Assign Co-AuthorAdd or change the co-author for the draft.
Reassign OwnershipTransfer document ownership to another team member.
DeletePermanently delete the draft. This cannot be undone.
Deleting a draft is permanent and cannot be undone. If you want to preserve the content but stop working on it, archive the document once it has been published instead.

Exporting documents

Published documents can be exported in two formats:
  • Word (.docx), a formatted document ready for email, printing, or upload to other systems. You can upload a custom Word template under your profile settings to match your brand.
  • Markdown (.md), plain text with Markdown formatting, suitable for pasting into wikis, pushing to a vector database, or use in AI/RAG workflows.
Use the Markdown export to keep your AI agents up to date with your latest processes. Push the export to your vector store whenever you publish a new version, or automate the process with a webhook.