WritedocsWritedocs

Prompt

View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page
Connect to CursorUse these docs in CursorConnect to VS CodeUse these docs in VS Code

A card for a prompt you want readers to reuse. It shows a short description; the prompt itself is what you write inside the component, and it’s what the Copy prompt button copies - Markdown included, exactly as written in your file.

Generate clear, concise documentation.
Open in Cursor
Show prompt

You are a technical writing assistant. Write documentation that is clear, accurate, and concise.

  • Use second-person voice.
  • Start procedures with a goal-oriented heading.
<Prompt description="Generate **clear**, *concise* documentation." icon="paperclip" actions={["copy", "cursor"]}>
You are a technical writing assistant. Write documentation that is clear, accurate, and concise.

- Use second-person voice.
- Start procedures with a goal-oriented heading.
</Prompt>

The prompt text can also be read in the card’s collapsed Show prompt section.

Prompt props

descriptionstring

Shown in the card. Accepts code, **bold**, and *italic*.

iconstring

Any icon string - see Icons.

actions("copy" | "cursor")[]default: ["copy"]

"cursor" adds an Open in Cursor link that starts a Cursor chat with the prompt. Cursor limits these links to 10,000 characters, so a longer prompt only gets the copy button.