user-guide-creation by aj-geddes/useful-ai-prompts
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill user-guide-creation创建清晰、用户友好的文档,通过分步说明、屏幕截图和实际示例,帮助用户理解并有效使用您的产品。
最小工作示例:
# [产品名称] 用户指南
## 目录
1. [简介](#introduction)
2. [开始使用](#getting-started)
3. [主要功能](#key-features)
4. [常见任务](#common-tasks)
5. [故障排除](#troubleshooting)
6. [常见问题解答](#faq)
7. [支持](#support)
## 简介
### 什么是 [产品名称]?
[产品名称] 是一个 [产品功能及其主要用途的简要描述]。
### 本指南面向谁?
本指南专为以下用户设计:
- 刚开始使用 [产品名称] 的新用户
- 希望学习高级功能的现有用户
- 管理 [产品名称] 的管理员
// ... (完整实现请参阅参考指南)
```
## 参考指南
`references/` 目录中的详细实现:
| 指南 | 内容 |
|---|---|
| [系统要求](references/system-requirements.md) | 系统要求 |
| [安装](references/installation.md) | 安装 |
| [初始设置](references/initial-setup.md) | 初始设置 |
| [任务 1:创建您的第一个项目](references/task-1-creating-your-first-project.md) | 任务 1:创建您的第一个项目 |
| [任务 2:导入现有数据](references/task-2-importing-existing-data.md) | 任务 2:导入现有数据 |
| [任务 3:导出数据](references/task-3-exporting-data.md) | 任务 3:导出数据 |
## 最佳实践
### ✅ 建议做法
- 使用简单、清晰的语言
- 包含屏幕截图和视觉元素
- 提供分步说明
- 对顺序任务使用编号列表
- 添加提示、警告和注意事项
- 包含键盘快捷键
- 提供完成任务的多种途径
- 测试您记录的每个步骤
- 保持内容最新
- 使用一致的格式
- 为长篇指南添加目录
- 包含搜索功能
### ❌ 避免做法
- 使用未加解释的行话
- 假设用户具备先验知识
- 跳过重要步骤
- 使用过时的屏幕截图
- 撰写大段文字
- 忘记为新版本更新内容
- 将简单任务复杂化
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
每周安装量
150
代码仓库
GitHub 星标数
127
首次出现
2026年1月21日
安全审计
已安装于
opencode126
gemini-cli123
codex122
claude-code114
cursor111
github-copilot105
Create clear, user-friendly documentation that helps users understand and effectively use your product, with step-by-step instructions, screenshots, and practical examples.
Minimal working example:
# [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
Weekly Installs
150
Repository
GitHub Stars
127
First Seen
Jan 21, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
opencode126
gemini-cli123
codex122
claude-code114
cursor111
github-copilot105
注册流程转化率优化指南:减少摩擦、提高完成率的专家技巧
30,600 周安装
AI实施方案生成器 - 创建机器可读、结构化的自动化执行计划
8,300 周安装
Python MCP 服务器生成器 - 快速构建 Model Context Protocol 服务器工具
8,400 周安装
MCP-CLI:命令行访问MCP服务器的工具,支持GitHub、文件系统、数据库交互
8,300 周安装
GitHub Copilot PRD生成工具 - AI产品经理助手,自动创建详细产品需求文档
8,300 周安装
GitHub Copilot代码审查与重构工具 - 资深工程师AI助手,自动优化代码质量与规范
8,400 周安装
Nano Banana Pro OpenRouter:基于OpenRouter的AI图像生成与编辑工具,支持Gemini-3-Pro模型
8,400 周安装