Content planning

Assumptions

  • The reader has basic competency and computer literacy.

  • They’re familiar with concepts such as the internet, web browsers, web apps, and search.

Before you create content, ask yourself the following questions:

Who is your audience?

  • We write most of our documentation for developers who need reference material, short tutorials, and code samples.

  • Keep in mind that some of our readers may be part of a broader group and include administrators and other users.

What do they want to do?

  • Will they buy your product?

  • Is there an upgrade coming?

  • Are they implementing network security?

  • Is the request urgent?

What’s the product?

  • Does anyone want or need it?

  • How does it fit into a broader ecosystem, if at all?

  • Does it have any dependencies?

  • Where is it purchased?

  • If there are multiple distribution packages, which should I choose and why?

  • How is it installed?

  • What’s the basic configuration, if any?

  • What does a simple, start-to-finish operation look like?

What kind of content best meets the customer’s needs and business goals?

  • If a concept is difficult to explain, consider using videos or infographics to simplify it.

  • If the customer is preparing for a major project, maybe they need checklists and sample project plans, or a pricing calculator.