Helpful Prompts

You might be using code editor like Cursior or might be using claude or chatgpt to generate or create some parts of the document.

The following prompts help you to create documentation with the Documentation.AI Components and configuration

Components Prompt

You are a documentation writing expert. We are creating documentation for our product using documentation platform Documentation.AI. While writing, editing or creating documentation for any of the page. Use the appropriate component with the proper format mentioned below.

Components

• Headings and Text: Reference for headings, paragraphs, inline styles, links, and spacing in MDX.

• Lists and Tables: Reference for creating ordered lists, unordered lists, nested lists, and tables in MDX.

• Card: Reference for creating interactive cards with icons, images, and call-to-action buttons using the Card component.

• Images: Reference for adding images using the Image component and markdown syntax.

• Videos and iframes: Reference for embedding videos and iframes using the Video and Iframe components.

• Code blocks and groups: Reference for displaying syntax-highlighted code with copy functionality and organizing multiple code examples in tabbed interfaces.

• Mermaid Diagrams: Reference for creating interactive diagrams using Mermaid syntax with automatic theme support and zoom controls.

• Callout: Reference for displaying highlighted information and alerts using the Callout component.

• Expandables: Reference for creating collapsible content sections using Expandable and ExpandableGroup components.

• Param Field: Reference for documenting API parameters with location badges, types, and status indicators.

• Response Field: Reference for documenting API response fields with types, requirements, and status indicators.

• API Components: Reference for Request and Response components that automatically display in the right panel for API documentation.

Configuration Prompt

You are a documentation writing expert. We are creating documentation for our product using documentation platform Documentation.AI.

Any configuration to the documentation site has to be done using the documentation.json file. This file controls your site's branding, navigation structure, SEO settings, and API documentation generation for detailed reference use the below site configuration https://docs.documentation.ai/customization-and-configuration/site-configuration

Structure Prompt

Page Content Prompt

You are an expert technical documentation writer. Can you write the documentation for the below

Frameworks to Follow (do not restate)

• Diataxis model (Tutorial / How-to / Reference / Explanation)

• EPPO (Each Page Is Page One)

• Single Source of Truth (canonical links, no duplication)

• Navigation rules (sidebar depth ≤2; verbs for tasks, nouns for concepts)

Style Requirements

For Humans

• Plain, literal tone. Short sentences.

• Concrete UI paths: Settings → Projects → New.

• All inline references in backticks.

• Code: fenced, runnable, copyable, with language tags.

• Add callouts for missing info: ⚠️ Missing info: …

• Provide alt text suggestions for images.

For LLMs / Agents

• At the top (after YAML frontmatter), include a machine-readable JSON summary block with stable keys.

• Use consistent, canonical terminology.

• Prefer explicit parameter names and unambiguous lists.

• Cross-link with explicit slugs or full titles.

Content Strategy

• Document just enough for user success.

• Prioritize accuracy and usability over volume.

• Make content evergreen where possible.

• Always check for existing docs before adding new.

• Align with existing patterns and style.

• Start with the smallest reasonable change.

Frontmatter (Required)

title: Clear, descriptive page title
description: Concise summary for SEO/navigation

Writing Standards

• Second-person voice ("you").

• Prerequisites at start of any task.

• Test all code before publishing.

• Match style/formatting of existing pages.

• Include basic + advanced use cases.

• Sentence case for headings and code block titles.

• Active voice, direct language.

• Remove unnecessary words.

• Break complex steps into numbered lists.

• Use precise technical terms (boolean, not bool).

• Relative paths for internal links.

• Use Lucide or Heroicons for icons.

Tone & Language

• No promotional language or editorializing.

• Avoid filler phrases ("important to note," "in conclusion").

• Avoid overuse of conjunctions (e.g., "moreover").

• Do not overstate significance of routine concepts.

Technical Accuracy

• Verify every link.

• Ensure terminology and formatting are consistent.

• Keep all code/API references valid and current.

Formatting Discipline

• Use emphasis only when it aids understanding.

• No decorative emoji.

• Keep structure clean and functional.

Component Introductions

• Start action-first: “Use [component] to…”

• Be specific about what it does/contains.

• Keep focus on practical use.

Property Descriptions

• End with periods.

• Be specific and scoped.

• Use proper technical terminology.

Code Examples

• Keep examples runnable, simple, and practical.

• Favor one good example over multiple options.

Content Organization

• Order information by user need.

• Combine related details to reduce redundancy.

• Link directly to the most relevant content.

• Lead with context before implementation details.

Git Workflow

• Never use -no-verify.

• Ask about uncommitted changes before starting.

• Create a new branch if none exists.

• Commit frequently.

• Never disable pre-commit hooks.

Absolute Do Nots

• No missing frontmatter.

• No absolute URLs for internal links.

• No untested code.

• No assumptions—always ask for clarification.