Skip to content
Skills Library
Sales & customer service · Writing

help-documentation

/help-documentation

Writes user-facing help-center articles - verb-first how-to guides, symptom-organized troubleshooting pages, and FAQs - with one task per article, exact UI labels, and a stated success result. Use when someone asks "write a help article for...", "document how users reset their password", "turn these support tickets into a troubleshooting page", or "our help center articles are confusing, rewrite this one". Do NOT use for internal team procedures and SOPs - use process-doc instead; for on-call operational runbooks, use runbook-writer; for internal knowledge-base articles aimed at support agents

Repository
skills ↗
Licence
MIT
Last repository change
13.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 13.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Writes user-facing help-center articles - verb-first how-to guides, symptom-organized troubleshooting pages, and FAQs - with one task per article, exact UI labels, and a stated success result. Use when someone asks "write a help article for...", "document how users reset their password", "turn these support tickets into a troubleshooting page", or "our help center articles are confusing, rewrite this one". Do NOT use for internal team procedures and SOPs - use process-doc instead; for on-call operational runbooks, use runbook-writer; for internal knowledge-base articles aimed at support agents

Triggers from the description

write a help article for...document how users reset their passwordturn these support tickets into a troubleshooting pageour help center articles are confusing, rewrite this one
Original author description

Writes user-facing help-center articles - verb-first how-to guides, symptom-organized troubleshooting pages, and FAQs - with one task per article, exact UI labels, and a stated success result. Use when someone asks "write a help article for...", "document how users reset their password", "turn these support tickets into a troubleshooting page", or "our help center articles are confusing, rewrite this one". Do NOT use for internal team procedures and SOPs - use process-doc instead; for on-call operational runbooks, use runbook-writer; for internal knowledge-base articles aimed at support agents

How it works

  1. Operating procedure
  2. Skeleton: how-to article
  3. Deliverable
  4. Do NOT
  5. Quality bar
Original SKILL.md headings · 95 lines, 850 words
SKILL.md preview
---
name: help-documentation
description: Writes user-facing help-center articles - verb-first how-to guides, symptom-organized troubleshooting pages, and FAQs - with one task per article, exact UI labels, and a stated success result. Use when someone asks "write a help article for...", "document how users reset their password", "turn these support tickets into a troubleshooting page", or "our help center articles are confusing, rewrite this one". Do NOT use for internal team procedures and SOPs - use process-doc instead; for on-call operational runbooks, use runbook-writer; for internal knowledge-base articles aimed at support agents, use kb-article-writer.
metadata:
  title: "Help Documentation"
---

# Help Documentation

The reader of a help article arrives stuck, impatient, and looking for one specific answer; the job is to get them unstuck fast. The costly failure this skill prevents is the feature tour - an article organized around what the product has instead of what the user is trying to do, which the stuck user scrolls, fails to match to their problem, and abandons for a support ticket.

## Operating procedure

### Step 1: Gather inputs

1. The task or problem the article addresses, in the user's words (required). One article = one task; if the request covers several tasks, split into linked articles now.
2. The exact UI labels, menu paths, and screens involved (required - ask for screenshots or the live product; guessing labels produces instructions that fail on contact).
3. Audience and prerequisites: what plan/role/permissions the reader needs.
4. Platform or version differences that change the steps (default: none noted).
5. The most common failure points, from support tickets if available.

### Step 2: Choose the article type

This maps to the Diátaxis quadrants - pick one per article, never blend:

- **How-to guide** (task-oriented; most common): the user has a goal and needs numbered steps.
- **Troubleshooting** (problem-oriented): the user has a symptom and needs the fix.
- **Conceptual overview** (understanding-oriented): the user needs to understand a model before tasks make sense. Keep rare; link from task articles.
- **FAQ**: short direct answers to real questions in the user's words, linking to fuller articles for depth.

### Step 3: Write the title verb-first

Start with the verb and name the task exactly as users search: "Reset your password," "Export a report." Front-load the title and first sentence with the search keywords. Titles like "Password management" or "About reports" fail the search-match test.

### Step 4: Draft to the type's skeleton

How-to guide:
1. One-sentence intro: what they will accomplish plus prerequisites.
2. Numbered steps - one action per step, each starting with the verb, naming the exact button or menu label in bold, matching on-screen capitalization precisely. Ceiling: about 10 steps; past that, split the article.
3. A note or tip at each known stuck point.
4. Result statement: what success looks like ("You'll see a confirmation message").
5. Next steps / related articles.

Troubleshooting: organize by symptom - "If you see X..." then the fix; most common cause first; every fix ends in an action, and every dead end points to the next fix or to support.

### Step 5: Mark visuals and accessibility

Note where a screenshot helps and exactly what it should show; supply alt-text guidance for each. Never rely on color or position alone ("the red button on the right") - name the label. Spell out acronyms on first use; define any unavoidable jargon once.

### Step 6: Run the stuck-user test

Follow the steps against the actual UI (or have the requester verify). Any step where the reader must infer, decide between unstated options, or "simply configure" something fails the test and gets rewritten.

## Skeleton: how-to article

Copy and replace the [FILL] fields.

```
# [FILL: Verb] [FILL: object - the task as users search it]

[FILL: One sentence: what you'll accomplish.] You need [FILL: prerequisite/role/plan].

1. [FILL: Verb] **[FILL: exact UI label]**.
2. [FILL: Verb] **[FILL: exact UI label]**.
   > Tip: [FILL: note at the known stuck point]
3. [FILL: Verb] **[FILL: exact UI label]**.
   [Screenshot: [FILL: what it shows] - alt text: [FILL]]

**Result:** [FILL: what the user sees when it worked].

## Related articles
- [FILL: adjacent task 1]
- [FILL: adjacent task 2]
```

Contrast for a single step:

**Bad:** "Simply configure your notification settings to your preference."
**Good:** "Click **Settings**, then click **Notifications**, then turn on **Email me about mentions**." (Three actions = three steps in the real article.)

## Deliverable

Produce the article with: a verb-led, keyword-front-loaded title; a one-sentence intro with prerequisites; numbered one-action steps using exact bolded UI labels; tips at known stuck points; screenshot placements with alt text; a result statement; and a list of related articles to cross-link.

## Do NOT

- Do not document features instead of tasks; users search for what they want to DO.
- Do not cram multiple actions into one step ("Click Settings, then Privacy, then toggle X") - scanning readers lose their place.
- Do not paraphrase UI labels; "the sharing menu" fails when the button says **Invite**.
- Do not write walls of text; the stuck user scans for their step and bounces off paragraphs.
- Do not assume knowledge the stuck user lacks; the person reading a reset-password article does not know where Settings is.
- Do not blend a conceptual overview into a how-to; link to it instead.

## Quality bar

- Title starts with a verb and matches search phrasing.
- One task per article; every step is one action with the exact on-screen label.
- A result statement tells the reader they succeeded.
- Steps verified against the actual UI, not memory.
- No jargon left undefined; no color/position-only references; alt text noted for every screenshot.

Versions

The database has no other skills named help-documentation.

Database snapshot: 13.11.2026 · package version 91cce61ebb80 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100support-docs
    When the user needs to create help center articles, FAQs, troubleshooting guides, API documentation, or getting-started guides for customers.
  • 100kb-article-writer
    Turns a resolved support ticket into a clear, searchable knowledge-base or help center article. Use when someone asks "write a KB article from this resolved ticket", "turn these resolved tickets into help center articles", or "write an internal knowledge base article for our…
  • 100knowledge-base
    Use this skill when designing help center architecture, writing support articles, or optimizing search and self-service. Triggers on knowledge base, help center, support articles, self-service, article templates, search optimization, content taxonomy, and any task requiring help…
  • 100knowledge-base-article-writing
    Write clear, searchable help center articles and FAQ entries based on support data, product documentation, and common customer questions. Use when the user requests knowledge base article writing or provides relevant inputs for this workflow.
  • 90customer-support-knowledge-base
    Use when shipping help-center articles, onboarding support, runbooks or support agents. Build accurate support documentation and triage flows for user-facing systems. Do not use when internal speculative product with no users yet.
  • 90help-center
    Generates Intercom-bound help-center / knowledge-base articles for tech products organized by researched canonical collection taxonomy (getting-started, account, integrations, settings, advanced, troubleshooting, etc.). Produces a persona × collection × article matrix per…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.