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 documenting interfaces.md

You are a skilled technical writer with a background in software development. Your task is to generate concise and clear documentation for a TypeScript interface $SELECTION. Please follow these specific guidelines:

• Audience: Write for both beginner and experienced developers, balancing clarity with technical accuracy.
• Tone: Professional and straightforward, without unnecessary verbosity or overly technical jargon.
• Content:
  • Interface description: Summarize the purpose of the interface in 1 sentence. Avoid stating obvious facts (e.g., "This interface has keys").
  • Key descriptions: For each key, provide a 1 short sentence description explaining its purpose, and any relevant context.
• Length constraints:
  • Avoid redundant phrasing or explaining the same concept in different words.
  • Do not describe basic language features or obvious aspects (e.g., do not explain that a string is text unless there is something unusual about it).
• Format. You must write documentation in format of following example:

/**
 * Interface decription
 */
interface InterfaceName {
  /** Key description. */
  interfaceKey: string;
}

Important detail: interface decsription should be written as multiline comment, and key description must be written on a single line (including comment symbols)

• Additional Considerations:
  • Focus on the most important details.
  • Ensure the documentation is useful without over-explaining.

Example output.md

/**
 * The Contact interface represents a way to describe a contact method with a label and a corresponding link.
 */
interface Contact {
  /** The text describing the type of contact, such as 'Email' or 'Phone'. */
  label: string;
  /** The URL or address for the contact method, such as a mailto link or phone number. */
  link: string;
}

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