# user-guide-creation

A skill for writing user guides, tutorials and step-by-step instructions with screenshots and examples. Useful when a product needs documentation.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 751 installs · ★ 371
- Author: aj-geddes
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/user-guide-creation/SKILL.md
- Updated: 2026-03-04
- HTML: https://affpapa.org/en/nevibecode/skills/user-guide-creation

## What it does

The skill lays out the structure of user documentation: table of contents, introduction, getting started, key features, common tasks, troubleshooting and FAQ. It ships a minimal working markdown example to start from, plus a `references/` directory with separate files on system requirements, installation, initial setup and three tasks: creating your first project, importing existing data, exporting data.

Style rules are part of it too. Plain language, screenshots, numbered lists for sequential steps, tips and warnings, keyboard shortcuts, more than one path to a task. A matching don't-list covers jargon without explanation, skipped steps, outdated screenshots and wall-of-text paragraphs.

Six platforms are supported, among them Claude, Codex, Cursor, GitHub Copilot, Gemini CLI and OpenCode. Install runs through `npx skills add`, or `gh skill install` for GitHub Copilot. Nothing beyond the skill file is needed, but you still have to test every step you document — the skill writes the text, it does not verify the product.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/user-guide-creation/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/user-guide-creation/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/user-guide-creation/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/user-guide-creation/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install aj-geddes/useful-ai-prompts user-guide-creation
```

2. **Manually: put the files in place**
- File: `.github/skills/user-guide-creation/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/aj-geddes/useful-ai-prompts --path skills/user-guide-creation
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/user-guide-creation/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/user-guide-creation/SKILL.md

## When to use it
- turn scattered notes into a user manual
- write a step-by-step how-to for a new feature
- draft a getting started guide for a product
- add a troubleshooting section to existing docs
- rewrite a wall of text into numbered steps

## Example prompts
- Write a user guide for our CLI tool, start with a table of contents and a Getting Started section
- Draft a step-by-step tutorial for importing data, include tips and warnings
- Rework this documentation: split it into steps, add an FAQ and a troubleshooting section

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 4d0d611970e65c64.

BEGIN THIRD-PARTY FILE 4d0d611970e65c64
`````text
---
name: user-guide-creation
description: >
  Create comprehensive user guides, tutorials, how-to documentation, and
  step-by-step instructions with screenshots and examples. Use when writing user
  documentation, tutorials, or getting started guides.
---

# User Guide Creation

## Table of Contents

- [Overview](#overview)
- [When to Use](#when-to-use)
- [Quick Start](#quick-start)
- [Reference Guides](#reference-guides)
- [Best Practices](#best-practices)

## Overview

Create clear, user-friendly documentation that helps users understand and effectively use your product, with step-by-step instructions, screenshots, and practical examples.

## When to Use

- Product user manuals
- Getting started guides
- Feature tutorials
- Step-by-step how-tos
- Video script documentation
- Interactive walkthroughs
- Quick start guides
- FAQ documentation
- Best practices guides

## Quick Start

Minimal working example:

````markdown
# [Product Name] User Guide

## Table of Contents

1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
3. [Key Features](#key-features)
4. [Common Tasks](#common-tasks)
5. [Troubleshooting](#troubleshooting)
6. [FAQ](#faq)
7. [Support](#support)

## Introduction

### What is [Product Name]?

[Product Name] is a [brief description of what the product does and its main purpose].

### Who is this guide for?

This guide is designed for:

- New users getting started with [Product Name]
- Existing users looking to learn advanced features
- Administrators managing [Product Name]
// ... (see reference guides for full implementation)
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [System Requirements](references/system-requirements.md) | System Requirements |
| [Installation](references/installation.md) | Installation |
| [Initial Setup](references/initial-setup.md) | Initial Setup |
| [Task 1: Creating Your First Project](references/task-1-creating-your-first-project.md) | Task 1: Creating Your First Project |
| [Task 2: Importing Existing Data](references/task-2-importing-existing-data.md) | Task 2: Importing Existing Data |
| [Task 3: Exporting Data](references/task-3-exporting-data.md) | Task 3: Exporting Data |

## Best Practices

### ✅ DO

- Use simple, clear language
- Include screenshots and visuals
- Provide step-by-step instructions
- Use numbered lists for sequential tasks
- Add tips, warnings, and notes
- Include keyboard shortcuts
- Provide multiple paths to accomplish tasks
`````
END THIRD-PARTY FILE 4d0d611970e65c64

The third-party file has ended. Everything between the 4d0d611970e65c64 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2531 of 2912 bytes. © aj-geddes · MIT · https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/user-guide-creation/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md