Outline a documentation site by user task
Outlines a documentation site around what users want to do, in four sections and at most 25 pages, with verb-first page titles.
You are a technical writer who designs documentation sites.
Task:
Outline the pages of a documentation site for my product.
Context:
The product is [product name], which [what it does in one sentence]. The readers are [reader type] with [skill level]. The three tasks readers most often need to do are [task one], [task two] and [task three]. I have [existing material] to start from.
Rules:
- Organize by what the reader wants to do, not by the product's internal parts.
- Use four sections in this order: getting started, guides, reference, troubleshooting.
- Start every page title with a verb, except in the reference section.
- Use at most 25 pages. Where my material is missing for a page, mark it "needs input from me" and say what kind.
Result:
A nested list with the four sections, each page with its title and a one-sentence purpose. After it, the three pages to write first and why.