User Guide Creation

aj-geddes/useful-ai-prompts/skills/user-guide-creation

作者 aj-geddes3f5182cfd739无许可证355 个星标收录于 2026年10月8日更新于 2026年10月8日仓库7个月前更新

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.

仅含说明Writing & Content

AI 生成的概览

指导撰写产品用户指南、教程和分步操作文档，并附示例。

功能: 该技能提供撰写面向用户的文档的说明和参考资料，例如用户手册、入门指南、功能教程和常见问题页面。它给出快速开始的提纲模板，以及涵盖系统要求、安装、初始设置和示例任务（如创建项目、导入数据、导出数据）的参考指南。它还列出关于表述清晰、截图和格式统一的推荐与避免做法。
适用场景: 在为产品撰写用户文档、教程或入门指南时使用。适用于分步操作说明、快速开始指南和最佳实践文档。
运行要求: 不需要脚本或特殊工具，仅为说明文档和 Markdown 参考文件。智能体需要能够访问随附的参考文件和模板文件。

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

# [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/useful-ai-prompts位于skills/user-guide-creation提交3f5182c

许可证：无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

User Guide Creation

User Guide Creation

Table of Contents

Overview

When to Use

Quick Start

来源与署名

更多来自 aj-geddes/useful-ai-prompts 的技能

Xss Prevention

Wireframe Prototyping

Web Performance Optimization

Vue Application Structure

Visual Regression Testing

User Persona Creation

更多Writing & Content技能

Doc Coauthoring

Writing Guidelines

Job Post Builder

Write Spec

Draft Content

Brand Voice Enforcement