Skip to main content

Authoring craft

Knowing how the editor works is half of authoring; these articles cover what makes the content itself good. You learn how to give a flow one clear trigger and an unambiguous end, how to write bits that lead with the action, and when knowledge belongs in a reference rather than in a step, and how to reference the credentials a step uses without ever putting a secret in your content.

What makes a good flow​

A flow is a sequence of connected bits that leads someone to a defined outcome — a reusable template for a piece of work. Each time a person runs it, Floxar records their journey as a trail. A good flow is a repeatable, practical path: clear about when to start it, what "done" looks like, and every decision in between, yet simple enough to follow under pressure and to update as the process changes.

Writing effective bits​

A bit is the smallest unit of a flow: the text and interactive elements that tell the person on a step what to do right now. The best bits are just-in-time — they carry exactly the instruction needed to act at this step, and leave stable background knowledge to a linked reference.

Using references well​

A reference is read-only supporting knowledge a person may consult during a step — policy, definitions, limits, matrices, rationale. If the bit is the just-in-time instruction, the reference is its just-in-case companion: helpful when the reader wants depth, never required to finish the step.

Working with credentials in flows​

Some steps act on another system: they update a record in your CRM, close a ticket, or call an internal tool. Whoever performs that step, a person or an AI agent, needs access to that system. Your flow should never contain that access itself. When the step's automation uses the Secrets Vault, the bit declares it with a credential reference: it names the credential kept in the Vault and explains what the step needs it for, while the Vault holds the value and decides which agents may open it. The Vault is optional; if your team keeps credentials in another secrets manager, the step simply names no secret.

Diagrams in bits​

A diagram can carry what a paragraph cannot: the order of a handoff, which system calls which, where a decision branches. Bits can hold diagrams drawn as SVG, the vector format diagram tools and AI assistants produce. Most diagrams in Floxar are made the way the rest of the content is: you describe what you want to your AI client, it draws the diagram, and it writes it into the bit for you.