kb-article

Name: kb-article
Author: anthropics

2.0kinstalls2.7kforks

How to install kb-article?

anthropics/knowledge-work-plugins/kb-article

$npx -y skills add anthropics/knowledge-work-plugins --skill kb-article

Installs into the current project.

Summary

Draft a knowledge base article from a resolved issue or common question. Use when a ticket resolution is worth documenting for self-service, the same question keeps coming up, a workaround needs to be published, or a known issue should be communicated to customers.

Files · 1

View on GitHub

SKILL.md

1	# /kb-article
2
3	> If you see unfamiliar placeholders or need to check which tools are connected, see [CONNECTORS.md](../../CONNECTORS.md).
4
5	Draft a publish-ready knowledge base article from a resolved support issue, common question, or documented workaround. Structures the content for searchability and self-service.
6
7	## Usage
8
9	```
10	/kb-article <resolved issue, ticket reference, or topic description>
11	```
12
13	Examples:
14	- `/kb-article How to configure SSO with Okta — resolved this for 3 customers last month`
15	- `/kb-article Ticket #4521 — customer couldn't export data over 10k rows`
16	- `/kb-article Common question: how to set up webhook notifications`
17	- `/kb-article Known issue: dashboard charts not loading on Safari 16`
18
19	## Workflow
20
21	### 1. Understand the Source Material
22
23	Parse the input to identify:
24
25	- What was the problem? The original issue, question, or error
26	- What was the solution? The resolution, workaround, or answer
27	- Who does this affect? User type, plan level, or configuration
28	- How common is this? One-off or recurring issue
29	- What article type fits best? How-to, troubleshooting, FAQ, known issue, or reference (see article types below)
30
31	If a ticket reference is provided, look up the full context:
32
33	- ~~support platform: Pull the ticket thread, resolution, and any internal notes
34	- ~~knowledge base: Check if a similar article already exists (update vs. create new)
35	- ~~project tracker: Check if there's a related bug or feature request
36
37	### 2. Draft the Article
38
39	Using the article structure, formatting standards, and searchability best practices below:
40
41	- Follow the template for the chosen article type (how-to, troubleshooting, FAQ, known issue, or reference)
42	- Apply the searchability best practices: customer-language title, plain-language opening sentence, exact error messages, common synonyms
43	- Keep it scannable: headers, numbered steps, short paragraphs
44
45	### 3. Generate the Article
46
47	Present the draft with metadata:
48
49	```
50	## KB Article Draft
51
52	Title: [Article title]
53	Type: [How-to / Troubleshooting / FAQ / Known Issue / Reference]
54	Category: [Product area or topic]
55	Tags: [Searchable tags]
56	Audience: [All users / Admins / Developers / Specific plan]
57
58	---
59
60	[Full article content — using the appropriate template below]
61
62	---
63
64	### Publishing Notes
65	- Source: [Ticket #, customer conversation, or internal discussion]
66	- Existing articles to update: [If this overlaps with existing content]
67	- Review needed from: [SME or team if technical accuracy needs verification]
68	- Suggested review date: [When to revisit for accuracy]
69	```
70
71	### 4. Offer Next Steps
72
73	After generating the article:
74	- "Want me to check if a similar article already exists in your ~~knowledge base?"
75	- "Should I adjust the technical depth for a different audience?"
76	- "Want me to draft a companion article (e.g., a how-to to go with this troubleshooting guide)?"
77	- "Should I create an internal-only version with additional technical detail?"
78
79	---
80
81	## Article Structure and Formatting Standards
82
83	### Universal Article Elements
84
85	Every KB article should include:
86
87	1. Title: Clear, searchable, describes the outcome or problem (not internal jargon)
88	2. Overview: 1-2 sentences explaining what this article covers and who it's for
89	3. Body: Structured content appropriate to the article type
90	4. Related articles: Links to relevant companion content
91	5. Metadata: Category, tags, audience, last updated date
92
93	### Formatting Rules
94
95	- Use headers (H2, H3) to break content into scannable sections
96	- Use numbered lists for sequential steps
97	- Use bullet lists for non-sequential items
98	- Use bold for UI element names, key terms, and emphasis
99	- Use code blocks for commands, API calls, error messages, and configuration values
100	- Use tables for comparisons, options, or reference data
101	- Use callouts/notes for warnings, tips, and important caveats
102	- Keep paragraphs short — 2-4 sentences max
103	- One idea per section — if a section covers two topics, split it
104
105	## Writing for Searchability
106
107	Articles are useless if customers can't find them. Optimize every article for search:
108
109	### Title Best Practices
110
111	\| Good Title \| Bad Title \| Why \|
112	\|------------\|-----------\|-----\|
113	\| "How to configure SSO with Okta" \| "SSO Setup" \| Specific, includes the tool name customers search for \|
114	\| "Fix: Dashboard shows blank page" \| "Dashboard Issue" \| Includes the symptom customers experience \|
115	\| "API rate limits and quotas" \| "API Information" \| Includes the specific terms customers search for \|
116	\| "Error: 'Connection refused' when importing data" \| "Import Problems

People who liked this also viewed

6 picks

Type

kb-article

2.0kinstalls2.7kforks

View on GitHub

How to install kb-article?

anthropics/knowledge-work-plugins/kb-article

$npx -y skills add anthropics/knowledge-work-plugins --skill kb-article

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# /kb-article
2
3	> If you see unfamiliar placeholders or need to check which tools are connected, see [CONNECTORS.md](../../CONNECTORS.md).
4
5	Draft a publish-ready knowledge base article from a resolved support issue, common question, or documented workaround. Structures the content for searchability and self-service.
6
7	## Usage
8
9	```
10	/kb-article <resolved issue, ticket reference, or topic description>
11	```
12
13	Examples:
14	- `/kb-article How to configure SSO with Okta — resolved this for 3 customers last month`
15	- `/kb-article Ticket #4521 — customer couldn't export data over 10k rows`
16	- `/kb-article Common question: how to set up webhook notifications`
17	- `/kb-article Known issue: dashboard charts not loading on Safari 16`
18
19	## Workflow
20
21	### 1. Understand the Source Material
22
23	Parse the input to identify:
24
25	- What was the problem? The original issue, question, or error
26	- What was the solution? The resolution, workaround, or answer
27	- Who does this affect? User type, plan level, or configuration
28	- How common is this? One-off or recurring issue
29	- What article type fits best? How-to, troubleshooting, FAQ, known issue, or reference (see article types below)
30
31	If a ticket reference is provided, look up the full context:
32
33	- ~~support platform: Pull the ticket thread, resolution, and any internal notes
34	- ~~knowledge base: Check if a similar article already exists (update vs. create new)
35	- ~~project tracker: Check if there's a related bug or feature request
36
37	### 2. Draft the Article
38
39	Using the article structure, formatting standards, and searchability best practices below:
40
41	- Follow the template for the chosen article type (how-to, troubleshooting, FAQ, known issue, or reference)
42	- Apply the searchability best practices: customer-language title, plain-language opening sentence, exact error messages, common synonyms
43	- Keep it scannable: headers, numbered steps, short paragraphs
44
45	### 3. Generate the Article
46
47	Present the draft with metadata:
48
49	```
50	## KB Article Draft
51
52	Title: [Article title]
53	Type: [How-to / Troubleshooting / FAQ / Known Issue / Reference]
54	Category: [Product area or topic]
55	Tags: [Searchable tags]
56	Audience: [All users / Admins / Developers / Specific plan]
57
58	---
59
60	[Full article content — using the appropriate template below]
61
62	---
63
64	### Publishing Notes
65	- Source: [Ticket #, customer conversation, or internal discussion]
66	- Existing articles to update: [If this overlaps with existing content]
67	- Review needed from: [SME or team if technical accuracy needs verification]
68	- Suggested review date: [When to revisit for accuracy]
69	```
70
71	### 4. Offer Next Steps
72
73	After generating the article:
74	- "Want me to check if a similar article already exists in your ~~knowledge base?"
75	- "Should I adjust the technical depth for a different audience?"
76	- "Want me to draft a companion article (e.g., a how-to to go with this troubleshooting guide)?"
77	- "Should I create an internal-only version with additional technical detail?"
78
79	---
80
81	## Article Structure and Formatting Standards
82
83	### Universal Article Elements
84
85	Every KB article should include:
86
87	1. Title: Clear, searchable, describes the outcome or problem (not internal jargon)
88	2. Overview: 1-2 sentences explaining what this article covers and who it's for
89	3. Body: Structured content appropriate to the article type
90	4. Related articles: Links to relevant companion content
91	5. Metadata: Category, tags, audience, last updated date
92
93	### Formatting Rules
94
95	- Use headers (H2, H3) to break content into scannable sections
96	- Use numbered lists for sequential steps
97	- Use bullet lists for non-sequential items
98	- Use bold for UI element names, key terms, and emphasis
99	- Use code blocks for commands, API calls, error messages, and configuration values
100	- Use tables for comparisons, options, or reference data
101	- Use callouts/notes for warnings, tips, and important caveats
102	- Keep paragraphs short — 2-4 sentences max
103	- One idea per section — if a section covers two topics, split it
104
105	## Writing for Searchability
106
107	Articles are useless if customers can't find them. Optimize every article for search:
108
109	### Title Best Practices
110
111	\| Good Title \| Bad Title \| Why \|
112	\|------------\|-----------\|-----\|
113	\| "How to configure SSO with Okta" \| "SSO Setup" \| Specific, includes the tool name customers search for \|
114	\| "Fix: Dashboard shows blank page" \| "Dashboard Issue" \| Includes the symptom customers experience \|
115	\| "API rate limits and quotas" \| "API Information" \| Includes the specific terms customers search for \|
116	\| "Error: 'Connection refused' when importing data" \| "Import Problems

People who liked this also viewed

6 picks

Type