• EnglishEspañol日本語한국어Português
  • 로그인지금 시작하기

Five questions to help write docs

Our five questions form the core of how our Tech Docs team thinks about writing excellent technical documentation. Informally, we call these our 5Qs.

Anyone can contribute to our docs site. We want you to feel confident and proud that your contributions provide valuable content and quality. We also want our readers to trust and easily use the information in our docs. To help you plan, write, and edit excellent docs, ask yourself the questions in this doc.

There's really only 1Q

The 5Qs exist to help answer one question. Whenever you write a doc, ask yourself:

What problem are we trying to solve?

It's critical you know what you're trying to do and why that goal matters to your readers. Asking the five questions (and the sub-questions!) will help you ensure you're building the right thing.

5Qs and sub-questions

Each of the five questions includes sub-questions to help guide your thinking.

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.