Project Intermediate

Build a Documentation Website with AI

The full path to docs people can actually navigate — plan the doc set, structure the site, write the guides and the API reference, then ship it as a coherent documentation site.

Overview

Documentation fails in a specific way: each page is fine, but the whole is a maze — no clear path from 'getting started' to 'reference', guides that assume what they should explain, an API section nobody can find. A documentation website is a structure problem before a writing one. This project builds one documentation-first: plan the doc set around what readers actually need to do, organize it into an information architecture that makes the next step obvious, write the conceptual guides and the API reference as distinct, deliberate layers, and ship it. It's specifically a documentation site — not a company marketing site, and not an internal knowledge base — so every decision serves a reader trying to accomplish a task with your product. Each stage connects to a NewPrompt workflow you can run on its own; together they turn scattered notes into docs a developer can navigate. You know the product; the project makes sure the docs are organized and complete instead of a pile of pages.

The journey

Each stage runs a NewPrompt workflow, with a supporting resource and tool. Work them in order — the output of each stage feeds the next.

See the execution map →
Define & Scope
Clarify what you're building and for whom.
  1. Plan the documentation set

    Decide what the docs must cover and for whom — the getting-started path, the how-to guides, the reference, the FAQs — driven by the tasks readers actually need to complete, not by what's easy to write.

    Outcome A planned doc set tied to what readers need to do.
Design
Design the right solution before building.
  1. Structure the docs site

    Organize the doc set into an information architecture — sections, hierarchy, and navigation — so a reader always knows where they are and what comes next, instead of getting lost three clicks in.

    Outcome An information architecture with a clear reading path.
Build & Refine
Build, test, secure, and make it production-ready.
  1. Write the guides and concepts

    Write the conceptual and how-to documentation — the layer that explains how the product works and walks a reader through real tasks — in clear, consistent prose generated from the actual behavior.

    Outcome Guides and conceptual docs that explain and walk through tasks.
  2. Write the API reference

    Document the API surface as a distinct reference layer — endpoints, parameters, responses, examples — complete and consistent, because reference docs are where a developer ends up when the guides run out.

    Outcome A complete, consistent API reference.
Ship & Validate
Ship with confidence and validate results.
  1. Ship the docs site

    Cross from built to live — check readiness, plan the deploy and a rollback, and decide what to watch — so the docs ship deliberately and the publishing pipeline is something you can rerun for every update.

    Outcome The documentation site shipped with a repeatable publish path.

Expected outcome

A documentation website a reader can navigate — a planned doc set, an information architecture with an obvious path from getting-started to reference, conceptual guides and an API reference written as distinct layers, and the whole thing shipped — instead of a maze of pages that are each fine and collectively unusable.

Best for

  • Building docs people can actually navigate
  • Planning the doc set and information architecture before writing pages
  • Teams shipping conceptual guides plus an API reference together

Not for

  • A marketing or company site — that is the Company Website project
  • A single README — docs that small do not need a journey

FAQ

How is this different from a company website?

Intent. This is documentation-first: a planned doc set, search-friendly structure, guides, and an API reference. A company site sells; docs explain.

Does it cover the API reference?

Yes — writing the API reference is its own stage alongside the conceptual guides, because reference and explanation serve different reader needs.

Do I need a docs framework first?

No — the journey plans content and structure regardless of tooling; you can map it onto whatever docs platform you ship on.

How do I build a documentation website with AI?

Run the five stages in order, each in your own AI tools. Plan the doc set around reader tasks, structure it into an information architecture, write the conceptual guides, write the API reference as a distinct layer, then ship with a repeatable publish path. NewPrompt supplies the prompts and workflows; you write and verify the docs.

What do I need before building documentation with AI?

Bring the raw material the docs describe: the product's actual behavior, your API surface — endpoints, parameters, responses — and the real tasks readers need to complete. The planning stage turns that into a doc set, so accurate source knowledge matters more than tooling; you can map the plan onto any docs platform afterward.

How do I keep AI-assisted documentation up to date?

Treat the ship stage's publish path as rerunnable. That final stage plans the deploy, a rollback, and what to watch, so publishing becomes a pipeline you rerun for every update rather than a one-time event. When the product changes, revisit the affected guide or API-reference stage and republish. Each republish and its accuracy are yours to check.

Workflows in this project

Resources used in this project

Tools used in this project

Ways to Use This Project Path

Practical project ideas you can build from this base project path — each opens in the Project Advisor.

Recommended next project

Related projects

Tip: Each stage opens its workflow — work them in order and carry the output forward.