Help Doc Writer

---
name: help-doc-writer
description: This prompt instructs the AI to produce a concise, skimmable help center article outline in Markdown for a provided topic, using only details explicitly included in the accompanying context and otherwise using neutral, generic guidance with clarifying notes. The output emphasizes second-person, step-based procedures with bold UI labels, brief sections, result-verification lines after each flow, and includes pragmatic Troubleshooting and FAQ entries without inventing product specifics, plan limits, or screenshots.
compatibility: Requires betterprompt >= 0.1.0
---

## What it does

This prompt instructs the AI to produce a concise, skimmable help center article outline in Markdown for a provided topic, using only details explicitly included in the accompanying context and otherwise using neutral, generic guidance with clarifying notes. The output emphasizes second-person, step-based procedures with bold UI labels, brief sections, result-verification lines after each flow, and includes pragmatic Troubleshooting and FAQ entries without inventing product specifics, plan limits, or screenshots.

> For more installation instructions go to https://skills.sh/betterpromptme/betterprompt/betterprompt to check out this skill.

## Inputs


### textInputs

Pass each text input using `--input <key>=<value>` flags.

| Variable key | Required? | Description | Defaults |
| --- | ---: | --- | --- |
| `topic` | Required |  | (none) |
| `additional_context` | Required |  | (none) |



### Models and options

This skill's modality is: **`text`**.

To discover which `model` values you can use (and which `options` keys/values are valid for each model), run:

```bash
betterprompt resources --models-only --json
```

Then filter the returned JSON array to entries where `modality` is `"text"`.

## How to run

### Step 1: Collect inputs

First, run `betterprompt resources --models-only --json` and filter to `modality: "text"` to discover valid models and available options:

```bash
betterprompt resources --models-only --json
```

Use only the models and option values that appear in the filtered results.

Then collect all inputs from the human:


- Required text inputs:
    - `topic`
  - `additional_context`
- Optional: model and options.
  - Present the human with the default model **`grok-4-fast`** and its available options. Look up `grok-4-fast` in the `betterprompt resources` output (filtered to modality `"text"`) and show its `availableOptions` as: `key: val1, val2 (default), val3  |  key2: ...`. Mark a value `(default)` if it matches these defaults: `{"reasoningEffort":"low"}`.
  - If the human does not specify, defaults are used: model `grok-4-fast`, options `{"reasoningEffort":"low"}`. Other models from the resources call are also available.

If any required text input is missing, **ask the human for what's missing**. Do not assume or fabricate values.

### Step 2: Run via BetterPrompt CLI

Use the frontmatter's `name` as the positional argument (for this skill, use `help-doc-writer`).

Command form:

```bash
betterprompt generate help-doc-writer \
  [--input <key>=<value>] \
  [--model <model>] \
  [--options <options JSON>] \
  [--json]
```

Notes:

- Pass each text input as a separate `--input <key>=<value>` flag.
- If the human does **not** mention a model, **omit** `--model` and BetterPrompt will use the default model: **`grok-4-fast`**.
- If the human does **not** mention options, **omit** `--options` and BetterPrompt will use the default options: **`{"reasoningEffort":"low"}`**.
- If the run times out, the response will include a `runId` you can use to fetch the result later.

Example (using defaults shown above):

```bash
betterprompt generate help-doc-writer \
  --input topic=<value> \
  --input additional_context=<value> \
  --model grok-4-fast \
  --options '{"reasoningEffort":"low"}'
```