Task documentation
Every task has technical documentation: a technical description and developer notes that people write, and a technical summary that Botream generates from the task itself. You read it in the documentation window and download it as a PDF report for the next developer or for a manager who reviews the task.
The summary is generated again every time you open the window or download the PDF, from the task as it is at that moment, so the document never falls behind the task. Nothing generated is stored.
Open the documentation
- In the editor: the Documentation button (the page icon next to History and Compare).
- On the Tasks page: a task's ⋯ menu → Documentation, or Download PDF to get the report at once.
The window shows the task name, its folder and version, and when the summary was generated, for example Generated from version 4 on 12 Oct 2026 10:30.
| Generated from | When |
|---|---|
| Published version | The version schedules and runs use. The default on the Public list and in the editor's public view. |
| My local copy | Your pulled or cloned copy, with changes you have saved but not pushed. The default in your local workspace. Unsaved changes in the editor are not included: save first. |
When you have a local copy of a published task, switch between the two at the top of the window.
Written parts
The technical description explains what the task is for, what it needs, what it does and what it produces. The developer notes hold what the next developer should know: fragile screens, test data, known issues, to-dos.
- Click Edit in the Written documentation card.
- Write in Markdown; the preview next to each field shows the result.
- Click Save.
Markdown you can use:
| Write | You get |
|---|---|
# Heading, ## Heading |
Headings |
- item or 1. item (indent two spaces to nest) |
Lists |
**bold**, *italic* |
bold, italic |
`code` and lines between ``` |
Code |
> text |
A quote |
Saving needs the Edit tasks permission (anyone who can open the task can read the documentation and download the PDF). It does not need a pull: the written parts belong to the task, not to a version. Botream remembers who saved them, when, and the task version that was current, and records the save in the audit log (TASK_DOCUMENTATION_UPDATE).
Note: When the task is pushed again after the written parts were saved, the window warns The task changed since this description was written (version 3 → 5). Check the text against the task and save it again; the generated summary is always current.
Improve with AI
Improve with AI rewrites the written parts into a clean, well-structured document. Botream sends the generated summary and the texts in the editors (saved or not) to the AI model set up under Administration → Settings → AI, and gets back:
- a technical description with the headings Purpose, Inputs, Process steps (in plain language), Outputs, Error handling and Dependencies;
- tidied developer notes that keep every fact, warning and to-do.
The result is shown next to the current text. Choose the language (English or Türkçe; the language of the app by default) and Try again if you want another version. Apply to the editors puts it into the editors without saving; change what you like and Save.
Passwords, keys and connection strings are never sent: the summary names vaults, credentials and connections but never contains their secrets. Without an AI model the button is disabled and tells you who sets it up.
The generated summary
| Section | What it shows |
|---|---|
| Overview | The task's description, its top-level steps (step descriptions) and the comments at its start |
| Inputs and outputs | input and output declarations with type, default and whether required |
| Variables | Every variable the task declares, its type and where it comes from |
| Process flow | The commands as an indented outline: steps, if/elseif/else, switch/case, loops, retry, try/catch/finally, onerror, with a one-line summary each; disabled commands are struck through |
| Dependencies | Applications and windows (window variables, window --action:open/attach, run, SAP connections), web addresses (browser, restapi), files and folders, databases (connection name, provider, server and database, never the connection string), e-mail accounts (server, vault and credential names), vaults and credentials (names only), called tasks (runtask, stoptask…), queues, human tasks and AI use |
| Schedules and triggers | What starts the task, whether active, the next run and where it runs |
| Error handling | onerror, try/catch blocks, retry blocks, commands with --onerror:continue, --retry and throw |
| Version history | Every pushed version with its author, date and note |
| Statistics | Number of commands, blocks, disabled commands, the deepest nesting, commands per category, and the success rate of the latest 100 runs |
Values that look secret (a set of a variable named like password or token, --password, connection strings, request headers) are shown as ***.
PDF report
Download PDF creates the report on the server from the same data: a cover with the task name, folder, version and date, a table of contents, the written parts, then the generated sections with tables and the flow outline. Every page after the cover has page numbers and the footer Botream · task · version N · generated date.
Click the button for the app's language, or open its menu to choose English or Türkçe. Section labels follow the chosen language; commands, parameters and names stay as they are. The font is embedded, so Turkish letters print correctly everywhere.
The API is GET /api/tasks/{id}/documentation.pdf?lang=en|tr&source=published|local.