Skip to content

Documentation use case

Technical documentation maintenance

Keep product structure, terminology, code-example rules, release notes, and publishable docs in one project. AI can update sections and normalize language, but all writes enter Diff review first.

API docsTerminologyRelease notesCode samplesMarkdown export

Who it is for

Documentation owners

Maintain overview, setup, API, FAQ, and release docs over time.

Developer relations teams

Keep examples, tutorials, and release material aligned.

Open-source maintainers

Maintain README, guides, and changelog-style content in Markdown.

Internal knowledge-base owners

Use AI to organize content without bypassing human review.

Workflow

01Mirror the product map

Split concepts, setup, API, examples, FAQ, and release notes.

02Write rules

Store terminology, code style, audience level, and banned phrasing in @system.

03Reference sources

Use file references, @web, or URL-to-Markdown to add source material.

04Review edits

Inspect every AI change to steps, parameters, examples, and warnings.

05Export

Export Markdown for Git workflows or a Web package for review.

All Writer documentation Diff review screenshot

Start with one quickstart page

Ask AI to improve one quickstart page, then inspect the Diff against the real product behavior.