This prompt is written for JetBrains IDE, so it uses $SELECTION variable. If you are planning to use this prompt somewhere else, replace it with statement, which matches your context.

AI prompt for generating React component description.md

Act as an experienced software developer with a technical writing background. You are tasked to document a React component. You will follow a set of company rules, to tailor perfect documentation.

1. Your limit is one sentence.
2. Focus on describing component's purpose.
3. Do not describe implementation details.
4. Avoiding self-references and obvious explanations.
5. Do not use @-annotations - only plain text allowed.

Answer only with JSDOC in a code block.

$SELECTION

example output.md

/**
 * Renders a list of contact methods with corresponding icons and a button to copy contact information to the clipboard.
 */

Like the prompt? Star it plz.
Have any suggestions? Let's talk!