Agent skill

user-guide-creation

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.

Stars 151
Forks 20

Install this agent skill to your Project

npx add-skill https://github.com/aj-geddes/useful-ai-prompts/tree/main/skills/user-guide-creation

SKILL.md

User Guide Creation

Table of Contents

  • Overview
  • When to Use
  • Quick Start
  • Reference Guides
  • 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

Expand your agent's capabilities with these related and highly-rated skills.

aj-geddes/useful-ai-prompts

websocket-implementation

Implement real-time bidirectional communication with WebSockets including connection management, message routing, and scaling. Use when building real-time features, chat systems, live notifications, or collaborative applications.

151 20
Explore
aj-geddes/useful-ai-prompts

refactor-legacy-code

Modernize and improve legacy codebases while maintaining functionality. Use when you need to refactor old code, reduce technical debt, modernize deprecated patterns, or improve code maintainability without breaking existing behavior.

151 20
Explore
aj-geddes/useful-ai-prompts

Sentiment Analysis

Classify text sentiment using NLP techniques, lexicon-based analysis, and machine learning for opinion mining, brand monitoring, and customer feedback analysis

151 20
Explore
aj-geddes/useful-ai-prompts

flask-api-development

Develop lightweight Flask APIs with routing, blueprints, database integration, authentication, and request/response handling. Use when building RESTful APIs, microservices, or lightweight web services with Flask.

151 20
Explore
aj-geddes/useful-ai-prompts

ML Model Explanation

Interpret machine learning models using SHAP, LIME, feature importance, partial dependence, and attention visualization for explainability

151 20
Explore
aj-geddes/useful-ai-prompts

Statistical Hypothesis Testing

Conduct statistical tests including t-tests, chi-square, ANOVA, and p-value analysis for statistical significance, hypothesis validation, and A/B testing

151 20
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results