Developer Tools
How to write a code binding quickstart page
A quickstart is the first page many developers judge a tool by. This guide walks through defining the starting input, showing a generated result and explaining what to check, with a worked schema example.
01
Step one: pick one input and one outcome
Begin with a single small input, such as a schema describing a user message with an id, a name and a list of tags. State the outcome in one sentence: after running one command, the reader will have a typed class they can import. Avoid listing every option at this stage. List prerequisites in a short block, including the required language version and one install command. A quickstart succeeds when a newcomer reaches a visible result in minutes, so every sentence before the first command should either prepare the reader or be removed.
02
Step two: show the generated code beside the source
Place the schema and the generated binding next to each other so readers see the mapping directly. In the user message example, show how the name field becomes a typed property and how the tag list becomes a collection. Add a three-line usage snippet that creates an object, sets values and serializes it. Explain naming rules briefly, such as how field names change case in the target language. Readers trust a tool more when they can predict its output, so keep the example real, copyable and small enough to read at once.
03
Step three: add a check and a change scenario
Finish with a verification step the reader can run, such as serializing the message and reading it back to confirm the values match. Then show one change: add an optional field to the schema, regenerate and point out what differs in the output. This demonstrates the workflow developers will repeat daily. Close with links to deeper topics like additional languages, build integration and versioning rules. Mark any behavior that depends on configuration so the page stays accurate, and test every command on a clean machine before publishing the page.