К основному содержанию
скилл CX Codex

user-guide-creation — скилл для Claude Code: руководства и туториалы

Скилл для написания пользовательских руководств, туториалов и пошаговых инструкций со скриншотами и примерами. Пригодится, когда нужна документация для продукта.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a claude-code
Открыть на GitHub

Что делает user-guide-creation

Скилл задаёт структуру пользовательской документации: оглавление, введение, начало работы, ключевые функции, типовые задачи, раздел с проблемами и FAQ. Внутри есть минимальный рабочий пример разметки, с которого можно начать, и папка references/ с отдельными файлами по системным требованиям, установке, первичной настройке и трём задачам: создание первого проекта, импорт данных, экспорт данных.

Правила оформления тоже прописаны. Простой язык, скриншоты, нумерованные списки для последовательных шагов, подсказки и предупреждения, горячие клавиши, несколько путей к одной задаче. Отдельно перечислено, чего избегать: жаргона без объяснений, пропущенных шагов, устаревших скриншотов и сплошного текста без разбивки.

Скилл рассчитан на шесть платформ, включая Claude, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Установка идёт через npx skills add, для GitHub Copilot — через gh skill install. Ничего кроме самого файла скилла не требуется, но проверять каждый описанный шаг придётся вам: скилл пишет текст, а не тестирует продукт.

Какие задачи решает

  • собрать руководство пользователя из разрозненных заметок
  • написать пошаговую инструкцию для новой функции
  • оформить getting started для продукта
  • дополнить документацию разделом с частыми проблемами
  • переписать сплошной текст в нумерованные шаги

Примеры запросов агенту

  • Напиши руководство пользователя для нашего CLI-инструмента, начни с оглавления и раздела «Начало работы»
  • Составь пошаговый туториал по импорту данных, добавь подсказки и предупреждения
  • Переделай эту документацию: разбей на шаги, добавь FAQ и раздел с проблемами

Как установить user-guide-creation

1Через Skills CLI (Vercel)

npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a claude-code

2Вручную: положить файлы

~/.claude/skills/user-guide-creation/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/user-guide-creation/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о user-guide-creation

Как установить user-guide-creation в Claude?

Выполните npx skills add aj-geddes/useful-ai-prompts --skill user-guide-creation -a claude-code. Файл скилла окажется в ~/.claude/skills/user-guide-creation/SKILL.md.

Что делает user-guide-creation?

Помогает писать пользовательские руководства, туториалы и пошаговые инструкции. Даёт структуру документа и правила оформления, включая работу со скриншотами и примерами.

На каких платформах работает этот скилл?

Claude, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Для каждой платформы своя команда установки, для GitHub Copilot это gh skill install aj-geddes/useful-ai-prompts user-guide-creation.

Исходный текст

SKILL.md · MIT
---
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
- Test every step you document
- Keep content up-to-date
- Use consistent formatting
- Add a table of contents for long guides
- Include search functionality

### ❌ DON'T

- Use jargon without explanation
- Assume prior knowledge
- Skip important steps
- Use outdated screenshots
- Write wall-of-text paragraphs
- Forget to update for new versions
- Overcomplicate simple tasks

© aj-geddes · MIT · aj-geddes/useful-ai-prompts

Похожие скиллы

Всё по теме «Тексты и документация» →
developer-tutorial Samuel Berthe Пишет и проверяет обучающие туториалы по продукту: один новый концепт на шаг, проверяемые чекпоинты и навык в конце. CX Codex +1 10 300установок dev-guide-generator zebbern Превращает техническую тему в готовый туториал: предварительные требования, настройка окружения, основные шаги, разбор ошибок и шпаргалка в конце. CX Codex +1 ★ 4 676звёзд репо 014-agile-user-story Juan Antonio Breña Moral Ведёт агента через опрос по шаблону и собирает user story в Markdown. Пригодится, когда требования нужно разбить на истории. CX Codex +1 339установок firecrawl-knowledge-ingest firecrawl Скилл для сохранения сайтов документации, справочников и баз знаний в markdown или JSON. Работает с динамическим контентом, авторизацией и пагинацией — нужен API-ключ Firecrawl. CX Codex +1 31 400установок vitepress Anthony Fu Скилл по VitePress: помогает агенту настраивать конфиг, тему и Markdown с Vue-компонентами при сборке сайта документации. CX Codex +1 11 800установок convert-plaintext-to-md официальный github Скилл для GitHub Copilot: превращает текстовый документ в Markdown — по инструкции из запроса, по готовому образцу или по заданным параметрам. 9 000установок

Из того же набора118

mobile-app-testing Задаёт правила тестирования приложений для iOS и Android. Помогает писать юнит-, UI- и интеграционные тесты с Jest, Detox, Espresso и XCTest. CX Codex +1 823установок technical-specification Помогает агенту писать техспеки, PRD, ADR и RFC: требования, архитектура, критерии приёмки. Пригодится, когда фичу надо описать до кода. CX Codex +1 804установок user-story-writing Оформляет требования к продукту в виде пользовательских историй с критериями приёмки Given-When-Then. Пригодится при планировании спринтов и ведении бэклога. CX Codex +1 787установок access-control-rbac Скилл, который помогает агенту проектировать ролевую модель доступа: роли, разрешения, политики и принцип наименьших привилегий. CX Codex +1 757установок kubernetes-deployment Помогает создавать манифесты и настраивать развёртывание приложений в Kubernetes: от rolling update и лимитов ресурсов до RBAC и проверок жизнеспособности подов. CX Codex +1 745установок logging-best-practices Скилл для настройки логирования: уровни, JSON-формат, контекст, защита PII и централизованный сбор логов. CX Codex +1 730установок flutter-development Скилл для разработки мобильных приложений на Flutter и Dart: виджеты, состояние через Provider или BLoC, навигация, интеграция с API. CX Codex +1 719установок visual-regression-testing Ловит случайные визуальные изменения интерфейса: снимает скриншоты компонентов и страниц и сравнивает их между версиями. CX Codex +1 718установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой