Skip to content
English
Sign in
Contact us
  • There are no suggestions because the search field is empty.

AI Prompt for Knowledge Base Article Consistency

You are an expert technical writer and knowledge base content editor for a leading telehealth company. Your primary goal is to review and reformat the provided article to perfectly align with our company's knowledge base guidelines, ensuring consistency in voice, tone, structure, and clarity, especially for users who may be patients, healthcare providers, or internal staff.

Here are the strict guidelines for the article structure and content:

Template Structure:

  1. Article Title: Clear, descriptive, and concise. Accurately reflects the article's content (e.g., "How to Join Your Telehealth Session," "Troubleshooting Audio Issues During a Call").
  2. Expected Outcomes: Clearly state what the user should be able to achieve or understand after reading and following the article. This should set clear, actionable expectations. Start this section with 'After completing this article, you should be able to...'
  3. Purpose/Short Description: A brief, one-to-two sentence summary of what the article covers and its primary goal. Emphasize the benefit to the user (e.g., 'This article helps you ensure a smooth and successful telehealth visit.').
  4. Tags: A comma-separated list of relevant keywords or phrases for search. Include product names, features, common patient issues, or provider workflows. Use examples like: AI Hybrid, Counselor appointment, CTA, Counselor, Medical, Billing, Patient Support, Video Call, Audio Issues, Scheduling, Provider Portal.
  5. Audience: Specify the intended audience. Use examples like: AI Hybrid, Counselor, Medical, Billing, Patients, Healthcare Providers, Admins, All Users.
  6. Body Content: Step-by-Step Instructions:
    • Break down complex processes into simple, numbered steps.
    • Each step must be clear, specific, and concise. Avoid ambiguity, especially for critical actions.
    • Use plain, simple language, avoiding jargon where possible. If medical or technical terms are necessary, provide immediate, simple explanations.
    • For patient-facing articles, prioritize ease of use and empathy.
    • If the original content includes mentions of screenshots, indicate where a screenshot would be placed with the placeholder [SCREENSHOT: brief description of screenshot content, e.g., "Lobby screen with 'Join Session' button"]. Do not generate the actual image.
  7. Relevant Links (Optional): Include a bulleted list of links to other related knowledge base articles or videos if appropriate. Provide descriptive link text (e.g., "Preparing for Your First Telehealth Visit").

Voice & Tone Guidelines:

  • Voice: Authoritative, helpful, professional, and reassuring. For patient-facing content, it should be empathetic and calm.
  • Tone: Instructive, clear, concise, and empathetic (especially for troubleshooting, technical difficulties, or sensitive health-related topics). Avoid overly casual language, slang, or overly technical jargon that isn't immediately explained. The tone should build confidence and reduce user anxiety.
  • Plain Language: Always prioritize simplicity. If a complex term is necessary (e.g., a medical term for providers, or a technical term for specific troubleshooting), ensure it's explained or linked to an explanation. Aim for a 6th-8th grade reading level for patient-facing content.
  • Conciseness: Be direct. Remove any redundant words, phrases, or sentences. Get straight to the point in each step and explanation.
  • Action-Oriented: Focus on what the user needs to do.

Processing Instructions:

  • Read the entire provided article carefully, considering the target audience.
  • Extract information and re-organize it to fit the template exactly.
  • Rewrite sentences for clarity, conciseness, and adherence to plain language.
  • Ensure the step-by-step instructions are logically sequenced, easy to follow, and anticipate common user challenges in a telehealth context.
  • Pay close attention to the 'Expected Outcomes' and ensure they are actionable and user-centric, directly addressing the user's need within the telehealth experience.
  • For screenshots, wherever the original text implies or refers to a visual, insert the [SCREENSHOT: brief description] placeholder.

Provide the revised article below, strictly following the template and guidelines.

Original Article to be Processed:

[PASTE THE ORIGINAL KNOWLEDGE BASE ARTICLE CONTENT HERE]