Use the Prompt
Add Your Brief
Add your context below. It will be included with the prompt when you copy or download.
Create a responsive HTML website using the existing project stack for [PROJECT] and [AUDIENCE]. The task is: Documentation Homepage.
Required content and structure
Organize getting started, concepts, task guides, API reference and troubleshooting.
Use [APPROVED_CONTENT] as the source of names, dates, figures, claims and destinations. List missing inputs before substituting anything. If a demonstration is needed, label its content as fictional. Do not invent customer quotes, rankings, partner logos or product capabilities.
Design direction
Use [BRAND_RULES] and the design system already selected in the project. If no system is supplied, start with this direction: warm ivory, charcoal typography and one restrained acid-green accent; generous spacing and an asymmetric grid. Keep type, spacing and color roles consistent. Prioritize the task over decorative elements and avoid a generic collection of unrelated cards.
Content preparation
List the first task a new user should complete, prerequisites, supported versions and the actual documentation destinations. Separate tutorials from reference material before designing the navigation.
Layout and behavior
Give the getting-started path a clear starting point, then organize deeper material around concepts, tasks and reference. Keep version context visible when a reader leaves the homepage.
Task-specific acceptance check
- Make the first successful task obvious and preserve version context.
- Ask whether a new user can choose a starting guide without knowing internal terminology.
- Test a renamed page, a missing search result and a version-specific link.
Implementation and review
Keep text editable. Use semantic structure, descriptive controls, visible keyboard focus and appropriate empty/error states. Check narrow and wide layouts. Respect reduced-motion preferences. Preserve any existing project framework and dependencies; do not silently replace the stack. Return the editable files and explain any incomplete behavior or unsupported inputs. Review this specific task before proposing extra features.
Reference attachment and reconstruction goal
Attach reference.webp from this prompt’s download bundle alongside this prompt in OpenDesign. Build an editable result with a similar composition and hierarchy; do not embed the whole reference image as the finished interface. Preserve approved project content and brand rules if they conflict with fictional sample labels. If the image is missing or unreadable, ask for it instead of claiming visual fidelity.
Reference composition and content
Use the attached reference.webp as the visual reference for Documentation Homepage. Before building, identify the major regions from top to bottom, their relative widths and heights, alignment, spacing, typography hierarchy, surface colors, borders, imagery and repeated components. Preserve those relationships rather than substituting a generic template. Required task content: Organize getting started, concepts, task guides, API reference and troubleshooting. Use the following task-specific layout guidance when translating the image into editable elements: Give the getting-started path a clear starting point, then organize deeper material around concepts, tasks and reference. Keep version context visible when a reader leaves the homepage.
Visual direction from the example brief
warm ivory, charcoal typography and one restrained acid-green accent; generous spacing and an asymmetric grid.
Interaction specification
The reference is a static concept: the behavior below is a requirement to implement, not proof that the picture already works. Copy the customized prompt into your working project. Start with the core task: Organize getting started, concepts, task guides, API reference and troubleshooting. Make the first successful task obvious and preserve version context. For each visible control, specify its trigger, affected state and feedback; implement local changes with consistent state across related views. Give search and filters real results, selection controls an explicit active state, and save actions visible pending/success/failure feedback where relevant. Do not add unrelated workflows. Use proper links for navigation, buttons for actions and accessible names for icon controls. Do not imply a backend operation succeeded when only a local demo changed.
Visual comparison and delivery
- Compare the result with the attached image at matching proportions. Review major region placement, relative image sizes, line breaks, spacing, typography hierarchy, contrast, active states and content density before polishing decorative details.
- Then test the narrow layout without squeezing desktop text into tiny labels.
- Keep logos, photos and icons as separate assets and all meaningful labels editable. List any unavailable fonts/assets and any intentional departures. Return the working files plus a concise account of implemented behavior and remaining integrations; do not promise a pixel-identical result from the prompt alone.
Download Prompt + Image
Includes the complete prompt and full-size reference image. Attach both in OpenDesign to guide the layout.
How to Write a Documentation Homepage Design Prompt
Use this documentation homepage design prompt to organize getting started, concepts, task guides, API reference and troubleshooting.
The reference is an AI-generated concept. The instructions below describe what to build and test; the image does not demonstrate working behavior.
Separate Learning Paths from Reference Lookup
Documentation serves people learning a concept and people looking up an exact API.
Mixing those tasks in one undifferentiated link grid makes both slower. Give the getting-started path a clear starting point, then organize deeper material around concepts, tasks and reference. Keep version context visible when a reader leaves the homepage.
From the Prompt
Give the getting-started path a clear starting point, then organize deeper material around concepts, tasks and reference.
Make It Your Own
Group getting started, concepts, task guides, API reference and troubleshooting. Use [TASK_LABELS] in entry descriptions and preserve a direct path to reference material.
Prepare the Documentation Homepage Content
Five cards separate getting started, concepts, task guides, API reference and troubleshooting. Prepare distinct destinations for these intents rather than routing every reader into one long page.
List the first task a new user should complete, prerequisites, supported versions and the actual documentation destinations. Separate tutorials from reference material before designing the navigation.
From the Prompt
Organize getting started, concepts, task guides, API reference and troubleshooting.
Make It Your Own
For [PROJECT], use [APPROVED_CONTENT] as the source for this documentation homepage. List the first task a new user should complete, prerequisites, supported versions and the actual documentation destinations. Separate tutorials from reference material before designing the navigation. Identify missing inputs before replacing them with demonstration content.
Follow a Newcomer and an Expert Path
The quick-start strip moves from creating a key to making a request and seeing a result. Verify that the linked guide completes this sequence with a concrete example.
One route should reach a first successful task; another should reach a specific API entry without reading the introduction again. Ask whether a new user can choose a starting guide without knowing internal terminology. Test a renamed page, a missing search result and a version-specific link.
From the Prompt
Make the first successful task obvious and preserve version context.
Make It Your Own
Review the documentation homepage against this requirement: Make the first successful task obvious and preserve version context. Ask whether a new user can choose a starting guide without knowing internal terminology. Test a renamed page, a missing search result and a version-specific link. Preserve approved content and revise only the parts that fail this check.
Review Your Documentation Homepage Result
Generated copy, routes and visual structure require review. Do not connect real forms, payments or external services without implementing and testing those flows.
- Ask whether a new user can choose a starting guide without knowing internal terminology. Test a renamed page, a missing search result and a version-specific link.
Follow-Up Prompt
Use this after the first result. It narrows the revision to the most important part of this task.
Refine the current documentation homepage. Ask whether a new user can choose a starting guide without knowing internal terminology. Test a renamed page, a missing search result and a version-specific link. Preserve the approved content and visual direction; change only the parts needed to resolve these issues.
