GitBook Docs
Website ↗Get started

Create your first guide

Start with one topic and a small collection of pages. You can expand the structure when you know what your readers need.

Choose a useful question

Pick a task you can explain from beginning to end. Name the audience and write down what they should be able to do after reading.

Create a simple outline

  1. Explain what the reader needs before starting.
  2. Write the steps in the order they will follow.
  3. Add an example that makes the result easy to recognize.
  4. Finish with a helpful next step.
Use descriptive titles. A heading such as “Create your first page” is easier to find than a broad label such as “Setup”.

Review the first version

Ask someone unfamiliar with the topic to follow the guide. Update any step that needs extra explanation, then share the page with your team.

Search documentation