Start with a clear foundation

Before you begin

Good documentation starts with a small, predictable structure. Give your readers one place to begin, one clear next step, and examples they can adapt.

Set up your workspace

1. Duplicate the template into your Framer workspace.
2. Replace the Nami name with your product name.
3. Open the Documentation collection and edit this article.
4. Preview on desktop and a narrow mobile screen.

Keep the first step small

An introduction should answer three questions: what the product does, what the reader needs, and what success looks like. Move optional configuration into a separate guide.

Your first example

Use fenced code blocks to present commands. Long lines scroll inside the block instead of widening the page.

curl https://api.example.com/v1/projects \
  -H "Authorization: Bearer YOUR_DEMO_TOKEN"

The endpoint above is illustrative. Never place a live token in public documentation.

Check the result

An example response makes the expected shape explicit. Describe omitted fields and optional values next to the example.

{
  "id": "project_demo",
  "name": "My first project",
  "status": "ready"
}

Next steps

• Read the writing guide for supported Markdown.
• Explore API examples for tables and errors.
• Open the Japanese guide to see Japanese typography.

Keep your setup path current. When a release changes an instruction, update the guide and add a changelog entry.