DocsUpdated 23 Oct 2026

Step by step guide

The Step by step guide schema describes a procedure as numbered steps, each with a title and content. Use it for tutorials, work instructions and how-to documents. It ships with the Productivity docs package.

Schema

Property	Value
Schema name	`Step by step guide`
Package	Productivity docs
Versioning	On — saves are kept in History when the subscription includes Revisions
Indexed for search	`Introduction` (5), `Elements.Title` (3), `Contents.Text` (1)

The guide's title is the document name.

Document fields

Field	Type	Meaning
`Introduction`	Text	Short description of the task
`Elements`	Array	The steps and chapters
`Criterias`, `Executors`, `Updaters`, `Reporting`, `Documentation`, `Time`	Lists of `{ Text }`	The properties panel: when to follow the guide, who may carry it out and change it, and the reporting, documentation and time requirements
`Efficiency`, `Knowledge`, `Precision`, `Control`	Check box	Goals ticked in the properties panel
`NoIndex`	Check box	"No index (Google)"
`HideHeader`, `NoSideNav`, `HideDate`, `ShowAnchors`, `ShowEditLink`, `Numbered`, `Striking`	Check box	Display options for the published guide
`Lock`	Check box	The edit-lock toggle in the editor
`Expand`	Check box	Whether the properties panel is open in the editor

Steps and content

ObjectVariant	Where	Fields
`Step`	`Elements`	`Title`, `Expand`, `Contents` (the step's content)
`Chapter`	`Elements`	`Title`, `Elements` (more steps), `Expand`, `DefaultCollapsed`, `ResetCounter` (restart the numbering), `Columns`, `Class`, `Style`
`Text`	`Contents`	`Text`, `Style`
`Image`	`Contents`	`Images` (`[{ Image }]`), `Size`
`Code`	`Contents`	`Code`, `Mode`
`List`	`Contents`	`Items` (`[{ Text, Items }]`)
`Quote`	`Contents`	`Text`, `Source`
`Table`	`Contents`	`Header`, `EvenColumns`, `Columns`, `Rows`

Templates and publishing

Template	Output
Online guide	The web version — downloadable and allowed for publishing
Online guide (bootstrap 4)	The same, built on Bootstrap 4
PDF Document, PDF Document (Chrome)	PDF versions

On a published site, a document of this schema is rendered with the site's display template #/Step by step guide.hash (or #/Step by step guide.html) when there is one. Without it, Docly uses the first template in the schema that allows publishing — here Online guide. See Create display templates for your schemas.

Many of this site's blog posts use the schema, and #/Step by step guide.hash renders them.

Create one

Install the Productivity docs package in the workspace (Standard packages), then choose the schema in a folder's New menu.
From a script, the drive or the CLI: write a .docly file whose Schema is Step by step guide — see The Docly file format and Creating new docly files. Copy an existing document for the full field set.