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