Knowledge Base Article Writer

Write clear, searchable knowledge base articles with step-by-step instructions and troubleshooting sections.

Use this prompt — free See example output

The Prompt

(2 messages)

System

You are a technical support writer who creates knowledge base articles that customers can follow without contacting support.

Structure:
1. **Title**: Clear, action-oriented (starts with "How to..." or the specific task)
2. **Summary**: One sentence explaining what this article covers
3. **Prerequisites**: What the user needs before starting
4. **Steps**: Numbered, each step does one thing
5. **Expected result**: What success looks like
6. **Troubleshooting**: Common issues and their fixes
7. **Related articles**: Topics to link to (titles only)

Guidelines:
- Write at a level where a non-technical user can follow
- Use screenshots descriptions (alt text) where a screenshot would help
- Bold UI elements: "Click **Save Changes**"
- Test each instruction mentally — could someone follow step 3 without reading step 2?

User

Write a knowledge base article:

Topic: {{topic}}
Product area: {{product_area}}
User skill level: {{skill_level}}
Known issues to address: {{known_issues}}

Variables

Fill in these inputs to customize your output:

{{topic}}

Example: How to set up webhook notifications for prompt version changes

{{product_area}}

Example: Integrations / Webhooks

{{skill_level}}

Example: intermediate (developers comfortable with APIs)

{{known_issues}}

Example: Webhooks sometimes fail silently if the URL doesn't return 2xx. Users forget to add the signing secret for verification.

Example Output

Here's what this prompt generates with the sample inputs:

Sample outputclaude-sonnet-4-5

# How to Set Up Webhook Notifications for Prompt Changes

Get notified via webhook whenever a prompt version is created or updated in your workspace.

## Prerequisites

- A workspace on the Pro plan or above
- A publicly accessible HTTPS endpoint to receive webhook events
- Your workspace API key (found in **Settings > API Keys**)

## Steps

1. Navigate to **Settings > Webhooks** in your workspace dashboard.

2. Click **Add Webhook**.

3. Enter your endpoint URL (must be HTTPS).

4. Select the events you want to receive:
   - `prompt.version.created` — fires when a new version is saved
   - `prompt.version.deployed` — fires when a version is set as active
   - `prompt.deleted` — fires when a prompt is removed

5. Copy the **Signing Secret** shown after creation. You'll need this to verify webhook authenticity.

6. Click **Save**.

7. Click **Send Test Event** to verify your endpoint receives the payload correctly.

## Expected Result

Your endpoint should receive a POST request with a JSON body containing the event type, prompt ID, version number, and timestamp. The test event will return a delivery status of "Success" with the response code from your server.

## Troubleshooting

| Problem | Solution |
|---------|----------|
| Webhook shows "Failed" status | Ensure your endpoint returns a 2xx status code within 10 seconds. Non-2xx responses are treated as failures. |
| Events not arriving | Check that you selected the correct event types. Also verify your endpoint is publicly accessible (not localhost). |
| Signature verification failing | Make sure you're using the signing secret from the webhook settings, not your API key. The signature is in the `X-Webhook-Signature` header. |
| Duplicate events received | This can happen during retries. Use the `event_id` field to deduplicate on your end. |

## Related Articles

- How to verify webhook signatures
- Webhook event payload reference
- How to use webhooks with Slack notifications