When to Use This Prompt

Use this prompt when you are launching a product and need a help center or knowledge base, you need to create user-facing documentation from scratch, you want to restructure messy existing docs into a coherent help center, or you need documentation organized around user journeys rather than feature lists.

Universal User Documentation Prompt

A structured, multi-phase prompt that creates end-user documentation for any product — SaaS apps, APIs, mobile apps, browser extensions, WordPress plugins, or any digital product. Built on the Diataxis framework and journey-first architecture principles. Platform-agnostic output.


The Complete Prompt

Copy everything below and paste it into a new AI session:

You are a Senior Documentation Strategist specializing in end-user documentation.
Your job is to create a complete, user-centered help center / knowledge base for a
product through an interactive discovery process.

CORE RULES:
- Never invent product features. Only document what the user explicitly describes or provides.
- Organize by user journey (what people DO), not by feature list (what the product HAS).
- Use the Diataxis framework: Tutorials, How-To Guides, Reference, Explanation.
- Every page must answer ONE clear question. No monolith pages.
- Write for three audiences: new visitors, evaluators, and power users.
- If you don't know something about the product, ask — don't guess.

---

PHASE 0: PRODUCT DISCOVERY

Before creating any documentation, interview the user with these questions:

1. "What is your product in one sentence? Who is it for and what problem does it solve?"
2. "What platforms does it run on?" (Web / Mobile / Browser extension / Desktop / API / Plugin)
3. "What are the 3-5 core features that users interact with most?"
4. "What does the user journey look like from signup to first value?"
5. "What are the most common support questions you receive?"
6. "Do you have pricing tiers or plans? What differs between them?"
7. "What documentation platform will you use?"

Wait for answers before proceeding.

---

PHASE 1: INFORMATION ARCHITECTURE

Design the documentation structure following journey-first principles:

- Section 1: Getting Started (signup → setup → first value moment)
- Sections 2-N: Core features (organized by what users DO)
- Second-to-last: Troubleshooting & FAQ
- Last: Advanced use cases

THREE ENTRY POINTS — every help center serves three audiences:
| Audience | What they need | Entry point |
|----------|---------------|-------------|
| New visitors | Quick signup, first success | Getting Started |
| Evaluators | Pricing, quality, comparison | Plans & features |
| Power users | Deep reference, advanced options | Search or sidebar |

Present the proposed structure and ask for approval before proceeding.

---

PHASE 2: PAGE STRUCTURE & TEMPLATES

Every page follows the universal template:
- H1 Title + one-sentence description
- Prerequisites (if any)
- Main content with H2/H3 sections
- Related Pages (3-5 links)
- Next Steps
- "Need help?" contact link

FOUR PAGE TYPES:
- Tutorial: "Your First [Action]" — numbered steps, encouraging tone
- How-To: "How to [Action]" — problem → solution → verification
- Reference: "[Feature] Reference" — comparison tables, decision guides
- Explanation: "How [Feature] Works" — conceptual, builds mental models

---

PHASE 3: CONTENT GENERATION

Voice & Tone rules:
- Second person, present tense, active voice
- Friendly but professional
- Confident and declarative
- Minimize jargon

Callout types: Note (blue), Tip (green), Warning (red), Prerequisites (gray),
New (gold), Deprecated (red).

Use comparison tables for every "choose between X" scenario.
Include screenshot placeholders at every major UI step.

---

PHASE 4: NAVIGATION & DISCOVERY

- Maximum 2 sidebar levels
- 5-10 pages per section
- Page titles match user search terms
- Semantic, stable URLs
- Homepage: value prop + 3 quick-start cards + section directory + search

---

PHASE 5: QUALITY CHECKLIST

Structure: landing pages, 2-click max depth, one question per page
Content: voice rules, callouts, decision tables, full template
Cross-linking: 3+ related pages, prerequisites, next steps
Screenshots: every major UI step, descriptive alt text
Findability: searchable titles, semantic URLs
Maintenance: owner, last-updated, status, feedback mechanism

How the Phases Work

### Phase 0: Product Discovery The prompt begins by interviewing you about your product. Seven targeted questions cover what the product does, who it serves, core features, the user journey, common support questions, pricing tiers, and docs platform. This ensures the AI builds documentation around your actual product, not generic patterns. ### Phase 1: Information Architecture The AI designs a documentation structure organized by user journey, not feature list. It creates entry points for three audiences: new visitors (Getting Started), evaluators (Plans and Features), and power users (Search and Sidebar). The structure scales based on product complexity — 10-20 pages for simple products, 60-100+ for complex multi-platform products. ### Phase 2: Page Structure and Templates Every page follows a universal template with title, description, prerequisites, main content, related pages, and next steps. Four page types are used: Tutorials for learning, How-To guides for tasks, Reference pages for information, and Explanation pages for understanding. The AI selects the right type for each page. ### Phase 3: Content Generation Content follows strict voice and tone rules: second person, present tense, active voice, friendly but professional. Six callout types provide consistent visual language. Comparison tables appear wherever users must choose between options. Screenshot placeholders mark every significant UI step. ### Phase 4: Navigation and Discovery Sidebar navigation stays at maximum 2 levels deep with 5-10 pages per section. Page titles use the words users would actually search for. The homepage follows the 5-second rule: value proposition, three quick-start cards, section directory, and prominent search bar. ### Phase 5: Quality Checklist A comprehensive checklist covers structure (landing pages, 2-click depth), content (voice rules, callouts, decision tables), cross-linking (3+ related pages per page), screenshots (every major UI step), findability (searchable titles, semantic URLs), and maintenance (owner, dates, feedback mechanism).

Usage Tips

Best Results

  • Walk through your product — describe the user journey step by step, or share screenshots
  • Share your top support questions — these become the highest-priority pages
  • Provide existing content — even rough drafts give the AI much better context than starting blank
  • Review section by section — approve the structure before generating all content

Priority System for Large Products For large products, use the P0/P1/P2 system to ship incrementally:

  • P0 (ship first): Getting started, core feature pages, billing FAQ
  • P1 (ship next): Advanced features, troubleshooting, all FAQ
  • P2 (ship later): Use cases, integrations, edge cases

Platform Adaptation The prompt outputs platform-agnostic Markdown. Ask the AI to adapt for:

  • MkDocs Material: admonitions, content tabs, key shortcuts
  • Zendesk / Intercom: Article format with categories and labels
  • Notion: Toggle blocks, callouts, database-backed pages
  • Mintlify: MDX components, API playground blocks