Flow.Documentation
ProfessionalThe basics

Documentation that writes itself

12 steps± 8 minVideoVerified 22 Oct 2026
  1. Step 1 · Open your development environment
  2. Step 2 · Open Docs
  3. Step 3 · A space that writes itself
  4. Step 4 · A page that writes itself
  5. Step 5 · A note on a part
  6. Step 6 · The API changes: the page writes itself again
  7. Step 7 · Loose notes
  8. Step 8 · A page from a template
  9. Step 9 · Writing and linking
  10. Step 10 · Steps
  11. Step 11 · Publishing for readers
  12. Step 12 · Comments
  13. Step 13 · An AI app writes along

In Docs you write the documentation of your solution next to building it, in the same studio. A module's space writes itself: for every API, workflow and table Flow makes a page from what it knows, and keeps it up to date when something changes. What people add lives in notes attached to a part, and stays. Next to that you write ordinary pages, for example a runbook from a template, which readers see as soon as you publish them. Secrets, table rows and personal data never end up on a page.

Watch the whole guide as a video13 steps in one film
Step 1 / 13

Open your development environment

In the portal, under Environments, click Development, and there Open. Flow opens in a new tab and you are signed in straight away.

  1. Click Development
Open your development environment · Click Development
  1. Click Open ↗
Open your development environment · Click Open ↗
Step 2 / 13

Open Docs

In the bar on the far left is Docs. There you find the spaces with their pages, and where they publish to. A new workspace has no spaces yet.

  1. Click Docs
Open Docs · Click Docs
Open Docs · ‘No spaces yet’, with ＋ top right for a new space.
Step 3 / 13

A space that writes itself

Click ＋ (New space) and under Of module choose the module Orders. Flow takes over the name; choose the language of the pages and the classification. After Create the space writes itself: an overview of the module, and a page per API, workflow and table, marked writes itself.

  1. Click New space
A space that writes itself · Click New space
  1. In Of module, choose Orders
A space that writes itself · In Of module, choose Orders
  1. Click Create
A space that writes itself · Click Create
A space that writes itself · The space Orders with a page per API, workflow and table.
Step 4 / 13

A page that writes itself

Open the API's page. At the top it says what it was made from, with the version. The grey parts with the lock come from Flow itself: how to sign in, the endpoints, what they do and who may call them, and an example without real data. On the right is what never ends up on such a page.

  1. Click Orders API v1 writes itself
A page that writes itself · Click Orders API v1 writes itself
A page that writes itself · The banner ‘Made from Orders API v1’ and the locked parts.
Step 5 / 13

A note on a part

Below every part is Add a note. Write what colleagues need to know about creating an order and click Save. The note is attached to this endpoint: when the page writes itself again, it stays.

  1. Click Add a note
A note on a part · Click Add a note
  1. In Add a note, type For large orders, notify Purchasing first. Partners often ask about this.
A note on a part · In Add a note, type For large orders, notify Purchasing first. Partners often ask about this.
  1. Click Save
A note on a part · Click Save
A note on a part · The note, with who wrote it and what it belongs to.
Step 6 / 13

The API changes: the page writes itself again

A builder gave the endpoint a description and removed the GET endpoint. Open the page again: Flow only makes it again when its source changed, and your note is still in its place. In History at the bottom it says Made again from ….

  1. Click Orders API v1 writes itself
The API changes: the page writes itself again · Click Orders API v1 writes itself
  1. Click HISTORY
The API changes: the page writes itself again · Click HISTORY
The API changes: the page writes itself again · The new description, and the note in the same place.
Step 7 / 13

Loose notes

The note on the GET endpoint no longer had a place: Flow does not throw it away but puts it in Loose notes, with the page and the part it belonged to. Read it, and put the text where it belongs now or remove it.

  1. Click Loose notes
Loose notes · Click Loose notes
Loose notes · The loose note, with the page and the part it belonged to.
Step 8 / 13

A page from a template

Click ＋ (New page) at the space. Give a title and choose the template Runbook: it starts with a warning and the usual headings. After Create the page opens as a draft.

  1. Click New page in Orders
A page from a template · Click New page in Orders
  1. In Title, type Orders runbook
A page from a template · In Title, type Orders runbook
  1. Click Runbook What to do when something goes wrong: from quick to thorough.
A page from a template · Click Runbook What to do when something goes wrong: from quick to thorough.
  1. Click Create
A page from a template · Click Create
A page from a template · The runbook as a draft, with the warning and the headings.
Step 9 / 13

Writing and linking

Click Edit. Until the new editor is there, you write in Markdown: # for a heading, - for a list, and [[title]] for a link to another page. Flow saves quietly while you type. Click Done.

  1. Click Edit
Writing and linking · Click Edit
  1. In Page content in Markdown, type `What to do when an order gets stuck.
Step 10 / 13

Steps

  1. Open [[Orders API v1]] and find the endpoint
  2. Look in the last run for what went wrong
Steps · Open [[Orders API v1]] and find the endpoint; Look in the last run for what went wrong;
  1. Click Done
Steps · Click Done
Steps · The steps, with the link to the API page.
Step 10 / 13

Publishing for readers

On the right in the inspector is the status: Draft. Readers only see what you publish; click Publish. The API page now lists the runbook under Refers to this.

  1. Click Publish
Publishing for readers · Click Publish
Publishing for readers · Status: Published.
Step 11 / 13

Comments

At the bottom a Docs page has Comments, History and References. Write a comment and click Post; colleagues reply below it and resolve it when it is sorted.

  1. Click COMMENTS
Comments · Click COMMENTS
  1. In Write a comment…, type Mention the payment step too?
Comments · In Write a comment…, type Mention the payment step too?
  1. Click Post
Comments · Click Post
Comments · The comment, with Reply and Resolve.
Step 12 / 13

An AI app writes along

With MCP access an AI app such as Claude Code reads the pages (list_spaces, get_page, search_docs) and writes drafts (draft_page) and explanations on a part (draft_note). Such an explanation is dashed on the page as a proposal: readers only see it once a person clicks Accept.

  1. Click Orders API v1 writes itself
An AI app writes along · Click Orders API v1 writes itself
An AI app writes along · The app's proposal, with Accept and Remove.
  1. Click Accept
An AI app writes along · Click Accept

This guide was carried out step by step on 22 Oct 2026 by an automated test on Flow (version 3e563176).