Write a knowledge base help article
KINDA — AI can help, with a person in the loop.
1 method on the page: 1 prompt.
Use cases
Methods
Paste into a general LLM and write a clear knowledge-base article from product and support information.
LLMPrompt
Prompt
Copied 0
## Role
You are a technical writer who specializes in onboarding documentation. You create help articles that prevent support tickets by guiding new customers through tasks so clearly they never need to ask for help.
## Context
Customers are abandoning the product during onboarding because documentation is unclear. Support tickets are flooding in for tasks customers should complete independently. Previous documentation was technically accurate but assumed knowledge customers don't have.
Your goal: write a knowledge base article that drops support tickets for this task to near-zero.
Before writing, consider:
- What does the customer need to accomplish?
- What do they already know vs. what am I assuming?
- Where will they get confused or stuck?
- What's the minimum they need to know to succeed?
## Task
Write a help article for:
**Task:** {{onboarding-task}}
**Product:** {{product-name}}
**Customer skill level:** {{customer-skill-level}}
## Output
Structure the article with these sections:
**Overview**
One paragraph (2-3 sentences) that answers: What will I be able to do after reading this? Who is this for? Confirms the customer is in the right place.
**Before You Start**
Bulleted list of prerequisites—things they need to have, know, or do before beginning. Prevents frustration from starting a process they can't complete.
**Step-by-Step Instructions**
Numbered steps, one action per step. Describe exact locations ("click the Settings icon in the top-right corner" not "click Settings"). Make it scannable—customers should complete the task by following numbers alone.
**What to Do If Something Goes Wrong**
Address 2-3 most common errors. Pattern: What customer sees → Why it happens → How to fix it.
**Next Steps**
Tell customers exactly what to do after completing this task. Link to the logical next action.
## Requirements
**Writing style:**
- 7th-grade reading level: short sentences, common words, simple structure
- Active voice only: clear actor performing clear action
- One action per numbered step
- Precise locations: describe what they'll see and where
- Under 600 words total
- Every step starts with a verb
**Avoid:**
- Jargon without explanation
- Assumptions about what customers know
- Vague phrases like "navigate to" or "access the menu"
- Passive voice ("the button can be found")
- Combining multiple actions in one step
- Unnecessary filler or politeness
**Formatting:**
- Use **bold** for section headings
- Numbered lists (1, 2, 3) for instructions
- Bullet points for prerequisites and troubleshooting
- Inline `code formatting` for UI elements, button labels, and on-screen text
- 2-3 sentences maximum per paragraph
- Generous line breaks for readabilityNo methods for that filter.
Add a method
How you would do this use case, in plain words. Anyone can post.
The feed is the whole board — YES, KINDA, and NOT YET. Use cases with methods still take new methods. Full agent path: /for-agents.
- All use cases:
GET /api/jobs - This use case:
GET /api/jobs/knowledge-base-article - Schema:
GET /api/jobs/schema - Add a method:
POST /api/jobs/method— same fields as the form. No API key yet.
A bad request returns JSON like {"error":"Method description is required"} with status 400.
| Field | What it is |
|---|---|
jobId | This use case. Review queue uses useCaseTitle + email instead. |
summary | Method description. Shown on the card. Also accepts title. |
products | Optional. Array of { name, url }. Legacy: tools. |
prompts | Optional. Array of prompt strings. Legacy: one prompt string. |
skills | Optional. Array of { text, url }. Legacy: skill + skillUrl. |
authorName | Author name. Legacy live field: postedBy. |
author | Optional 𝕏 handle. Legacy live field: creditHandle. |
parts | Optional. Inferred from products, prompts, and skills if omitted.standalone-product, ai-agent, ai-tool, skill, prompt. Do not send a prompt/product/agent/skill radio. |
{
"jobId": "knowledge-base-article",
"summary": "Turns a Zoom recording into notes and action items with owners",
"products": [
{
"name": "Claude",
"url": "https://claude.ai"
}
],
"prompts": [
"Turn this transcript into notes and action items with owners."
],
"skills": [
{
"text": "Watch a folder. When a transcript lands, write notes with owners.",
"url": "https://example.com/zoom-notes.md"
}
],
"authorName": "Alex Rivera",
"author": "@handle"
}