Web app example · a team explaining a product
This documentation example helps readers move through related instructions using a sidebar and previous or next links. Topic pages can include code samples with a copy action, giving a product team a clear home for setup and usage guidance.
Documentation needs ongoing care as a product changes. Break long tasks into pages with descriptive headings, test examples against the current product, and make it obvious when a page is meant for a particular version or audience.
Cleo is opening to founders in small batches. Join the waitlist and we'll save your spot.
Updated
A documentation site organizes topic pages in a sidebar and supports code examples, copy buttons and previous or next links. Use the sample to name the audience, the main action, and the smallest useful first version. Cleo HQ then helps turn your own brief into a product plan and a working build.
Give each page one task or question, then link related topics where readers are likely to need them. A sidebar is easier to scan when its labels match the language users bring to the problem. The example adds previous and next links for a sequence; use them for guided tasks, while keeping quick reference pages easy to reach directly.
Show the context needed to use it, label any values the reader must replace, and avoid including private keys or real customer data. The sample includes copy buttons to reduce friction, but a copied snippet still needs to be accurate and current. Run through instructions as a new user would, and explain expected output so readers can tell whether the step worked.
State the product version or last-reviewed date when it helps, and remove steps that no longer match the interface. Give readers a simple way to report a broken instruction, then assign someone to review reports. The example provides navigation and content pages; keeping those pages trustworthy depends on a publishing routine tied to actual product changes.