Create intermediate Works with: Any AI

SEO Brief for a Technical Documentation Page

Structured brief Has example

Make docs findable and helpful.

The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.

[VERIFY] is an editorial flag, not a blank to fill. Wherever the prompt shows [VERIFY], check that item against a reliable source before you use it.

Create an SEO and quality brief for a technical documentation page. Product and feature: [PRODUCT_FEATURE]. Users (beginner developers, administrators): [USERS]. Common search queries and support questions: [QUERIES]. Version information: [VERSIONS].

Specify a title that matches how users phrase tasks, a one-paragraph overview, prerequisites, step-by-step instructions with code or commands I will provide, expected results, troubleshooting for the top five errors, related pages, and version notes. Add rules: examples must be tested by the engineering team before publication [VERIFY], mark deprecated features, and include a last-reviewed date. Provide guidance on heading structure, internal links, and keeping a changelog, and a method to review search queries that lead to the page.

Also include a feedback mechanism design: a page-level question asking whether the page helped, a place for reporting errors, and a monthly review of the least helpful pages with owners and deadlines.

Include a short example of a troubleshooting entry written in the expected format: symptom, likely cause, fix, and how to confirm the fix, using an invented error message.

Fill in before use

Optional: type your details and the prompt above updates. Nothing is saved or sent.

Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.

Brief extract (invented)
Title: Export data to CSV
Overview: One paragraph: what the feature does and who can use it.
Prerequisites: Admin role; data set selected.
Steps: 1) Open Reports; 2) choose Export; 3) select CSV; 4) confirm.
Expected result: a file named report_YYYY-MM-DD.csv downloads.
Troubleshooting (top two): 'Export is empty' (check date filter); 'Permission denied' (ask an admin).
Version note: applies to version 4.2 and later [engineering to verify].
Last reviewed: date field.
Feedback mechanism: a short question at the bottom, 'Did this page help?', with a form for reporting errors.

• seo
• structured-brief