Back to Details

user-guide-creation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

User Guide Creation

用户指南创建

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
  • 产品用户手册
  • 入门指南
  • 功能教程
  • 分步操作指南
  • 视频脚本文档
  • 交互式演练
  • 快速入门指南
  • FAQ文档
  • 最佳实践指南

User Guide Template

用户指南模板

markdown
undefined
markdown
undefined

[Product Name] User Guide

[产品名称] 用户指南

Table of Contents

目录

  1. Introduction
  2. Getting Started
  3. Key Features
  4. Common Tasks
  5. Troubleshooting
  6. FAQ
  7. Support
  1. 简介
  2. 入门
  3. 核心功能
  4. 常见任务
  5. 故障排除
  6. 常见问题
  7. 支持

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]
本指南适用于：
  • 首次使用[产品名称]的新用户
  • 想要学习高级功能的现有用户
  • 管理[产品名称]的管理员

What you'll learn

你将学到的内容

By the end of this guide, you'll be able to:
  • ✓ Set up and configure [Product Name]
  • ✓ Perform common tasks efficiently
  • ✓ Troubleshoot common issues
  • ✓ Use advanced features
完成本指南后，你将能够：
  • ✓ 安装并配置[产品名称]
  • ✓ 高效完成常见任务
  • ✓ 排查常见问题
  • ✓ 使用高级功能

Getting Started

入门

System Requirements

系统要求

Before you begin, ensure your system meets these requirements:
RequirementMinimumRecommended
Operating SystemWindows 10, macOS 10.15, Ubuntu 20.04Latest version
RAM4 GB8 GB
Disk Space500 MB1 GB
InternetRequired for setupRequired
开始前，请确保你的系统满足以下要求：
要求项最低配置推荐配置
操作系统Windows 10, macOS 10.15, Ubuntu 20.04最新版本
内存4 GB8 GB
磁盘空间500 MB1 GB
网络安装时需要联网全程需要联网

Installation

安装步骤

Step 1: Download

步骤1：下载

  1. Visit https://example.com/download
  2. Click the Download button for your operating system
  3. Save the installer to your Downloads folder
Download page screenshot
  1. 访问 https://example.com/download
  2. 点击对应操作系统的下载按钮
  3. 将安装程序保存到你的下载文件夹
下载页面截图

Step 2: Install

步骤2：安装

For Windows:
  1. Double-click the downloaded 
    .exe
    file
  2. Click Yes when prompted by User Account Control
  3. Follow the installation wizard:
    • Accept the license agreement
    • Choose installation location
    • Select components to install
  4. Click Install
  5. Wait for installation to complete
  6. Click Finish
For macOS:
  1. Double-click the downloaded 
    .dmg
    file
  2. Drag the application icon to the Applications folder
  3. Eject the disk image
  4. Open Applications and double-click [Product Name]
  5. Click Open when prompted about opening downloaded applications
For Linux:
bash
undefined
Windows系统：
  1. 双击下载的
    .exe
    文件
  2. 用户账户控制弹窗时点击是
  3. 跟随安装向导操作：
    • 接受许可协议
    • 选择安装位置
    • 选择要安装的组件
  4. 点击安装
  5. 等待安装完成
  6. 点击完成
macOS系统：
  1. 双击下载的
    .dmg
    文件
  2. 将应用图标拖拽到应用程序文件夹
  3. 推出磁盘镜像
  4. 打开应用程序文件夹并双击[产品名称]
  5. 弹出“打开已下载应用”提示时点击打开
Linux系统：
bash
undefined

Download and install

下载并安装

wget https://example.com/downloads/product-name.deb sudo dpkg -i product-name.deb
wget https://example.com/downloads/product-name.deb sudo dpkg -i product-name.deb

Install dependencies if needed

如有需要，安装依赖

sudo apt-get install -f
undefined
sudo apt-get install -f
undefined

Step 3: First Launch

步骤3：首次启动

  1. Open [Product Name] from your Applications folder or Start menu
  2. You'll see the welcome screen
  3. Click Get Started to begin the setup wizard
  1. 从应用程序文件夹或开始菜单打开[产品名称]
  2. 你将看到欢迎界面
  3. 点击开始使用启动设置向导

Initial Setup

初始设置

Create Your Account

创建账户

  1. On the welcome screen, click Create Account
  2. Enter your information:
    • Email address
    • Password (minimum 8 characters)
    • Full name
  3. Click Sign Up
  4. Check your email for a verification link
  5. Click the link to verify your account
Account creation screen
💡 Tip: Use a password manager to generate and store a strong password.
  1. 在欢迎界面点击创建账户
  2. 输入你的信息：
    • 电子邮箱
    • 密码（至少8个字符）
    • 全名
  3. 点击注册
  4. 检查你的邮箱获取验证链接
  5. 点击链接验证你的账户
账户创建界面
💡 提示： 使用密码管理器生成并存储强密码。

Configure Preferences

配置偏好设置

  1. Click Settings in the top-right corner (⚙️ icon)
  2. Configure your preferences:
    General Tab:
    • Theme: Light, Dark, or Auto
    • Language: Select your preferred language
    • Notifications: Enable/disable desktop notifications
    Privacy Tab:
    • Analytics: Choose whether to share usage data
    • Crash reports: Help improve the product
  3. Click Save to apply changes
  1. 点击右上角的设置按钮（⚙️图标）
  2. 配置你的偏好：
    常规标签页：
    • 主题：浅色、深色或自动
    • 语言：选择你偏好的语言
    • 通知：启用/禁用桌面通知
    隐私标签页：
    • 分析数据：选择是否共享使用数据
    • 崩溃报告：帮助改进产品
  3. 点击保存应用更改

Key Features

核心功能

Feature 1: [Feature Name]

功能1：[功能名称]

What it does: [Brief description of the feature]
When to use it: [Scenarios where this feature is useful]
How to use it:
  1. Navigate to [Menu] > [Feature Name]
  2. Click [Action Button]
  3. Enter the required information:
    • Field 1: [Description]
    • Field 2: [Description]
  4. Click Submit
Example:
Let's say you want to [specific use case]:
1. Click the "+" button in the toolbar
2. Select "New Project"
3. Enter "My First Project" as the name
4. Choose "Web Application" as the type
5. Click "Create"
Result: You'll see your new project in the sidebar.
Feature example
⚠️ Note: This feature requires [Product Name] Pro. Upgrade in Settings > Billing.
功能用途： [简要描述功能]
适用场景： [该功能的适用场景]
使用方法：
  1. 导航至**[菜单] > [功能名称]**
  2. 点击**[操作按钮]**
  3. 输入所需信息：
    • 字段1：[描述]
    • 字段2：[描述]
  4. 点击提交
示例：
假设你想要[具体使用场景]：
1. 点击工具栏中的“+”按钮
2. 选择“新建项目”
3. 输入项目名称“我的第一个项目”
4. 选择类型为“Web应用”
5. 点击“创建”
结果： 你将在侧边栏看到新建的项目。
功能示例
⚠️ 注意： 该功能需要[产品名称] Pro版本。可在设置 > 账单页面升级。

Feature 2: [Feature Name]

功能2：[功能名称]

[Similar structure as Feature 1]
[与功能1结构相同]

Common Tasks

常见任务

Task 1: Creating Your First Project

任务1：创建你的第一个项目

Goal: Create a new project from scratch
Time required: 5 minutes
Prerequisites:
  • Active account
  • Completed initial setup
Steps:
  1. Open the project menu
    • Click File > New Project
    • Or press 
      Ctrl+N
      (Windows) or 
      Cmd+N
      (Mac)
  2. Choose project type
    • Select from available templates
    • Click Blank Project for this tutorial
  3. Configure project settings
    Name: My First Project
Location: ~/Documents/Projects
Template: Blank
  4. Add initial content
    • Click Add Item in the sidebar
    • Select item type
    • Fill in details
  5. Save your project
    • Click File > Save
    • Or press 
      Ctrl+S
      (Windows) or 
      Cmd+S
      (Mac)
✅ Success indicator: You'll see "Project saved successfully" in the bottom-right corner.
目标： 从零开始创建新项目
所需时间： 5分钟
前置条件：
  • 已激活账户
  • 完成初始设置
步骤：
  1. 打开项目菜单
    • 点击文件 > 新建项目
    • 或使用快捷键
      Ctrl+N
      （Windows）或
      Cmd+N
      （Mac）
  2. 选择项目类型
    • 从可用模板中选择
    • 本教程选择空白项目
  3. 配置项目设置
    名称：我的第一个项目
位置：~/Documents/Projects
模板：空白
  4. 添加初始内容
    • 点击侧边栏的添加项
    • 选择项类型
    • 填写详情
  5. 保存项目
    • 点击文件 > 保存
    • 或使用快捷键
      Ctrl+S
      （Windows）或
      Cmd+S
      （Mac）
✅ 成功标识： 右下角将显示“项目保存成功”提示。

Task 2: Importing Existing Data

任务2：导入现有数据

Goal: Import data from an external source
Supported formats: CSV, JSON, XML, Excel
Steps:
  1. Click Import in the toolbar
  2. Choose your data source:
    • From File: Upload a file from your computer
    • From URL: Enter a URL to fetch data
    • From Database: Connect to an external database
  3. For File Import:
    - Click "Choose File"
- Select your CSV/JSON file
- Click "Upload"
  4. Map your fields
    • Match source columns to destination fields
    • Set data types for each field
    • Preview the mapping
    Source FieldDestination FieldType
    emailEmail AddressText
    nameFull NameText
    createdCreated DateDate
  5. Import settings
    • Duplicate handling: Skip, Update, or Create new
    • Error handling: Stop on error or Continue
    • Batch size: 100 records per batch
  6. Click Start Import
Progress: You'll see a progress bar showing:
  • Records processed
  • Successful imports
  • Errors encountered
目标： 从外部源导入数据
支持格式： CSV、JSON、XML、Excel
步骤：
  1. 点击工具栏中的导入按钮
  2. 选择数据源：
    • 从文件： 从电脑上传文件
    • 从URL： 输入URL获取数据
    • 从数据库： 连接到外部数据库
  3. 文件导入步骤：
    - 点击“选择文件”
- 选择你的CSV/JSON文件
- 点击“上传”
  4. 字段映射
    • 将源列与目标字段匹配
    • 为每个字段设置数据类型
    • 预览映射结果
    源字段目标字段类型
    email电子邮箱文本
    name全名文本
    created创建日期日期
  5. 导入设置
    • 重复数据处理：跳过、更新或创建新条目
    • 错误处理：遇到错误时停止或继续
    • 批量大小：每批100条记录
  6. 点击开始导入
进度： 你将看到进度条显示：
  • 已处理记录数
  • 成功导入数
  • 遇到的错误数

Task 3: Exporting Data

任务3：导出数据

Goal: Export your data for backup or external use
Steps:
  1. Select the data to export
  2. Click Export button
  3. Choose format:
    • CSV: For spreadsheets
    • JSON: For APIs and code
    • PDF: For reports
    • Excel: For analysis
  4. Configure export options:
    Include headers: ✓
Date format: YYYY-MM-DD
Encoding: UTF-8
Compression: None / ZIP
  5. Click Export
  6. Save the file to your desired location
目标： 导出数据用于备份或外部使用
步骤：
  1. 选择要导出的数据
  2. 点击导出按钮
  3. 选择格式：
    • CSV： 适用于电子表格
    • JSON： 适用于API和代码
    • PDF： 适用于报告
    • Excel： 适用于分析
  4. 配置导出选项：
    包含表头：✓
日期格式：YYYY-MM-DD
编码：UTF-8
压缩：无 / ZIP
  5. 点击导出
  6. 将文件保存到指定位置

Troubleshooting

故障排除

Common Issues

常见问题

Issue: Application won't start

问题：应用无法启动

Symptoms: Double-clicking the icon doesn't launch the app
Possible causes:
  • Corrupted installation
  • Insufficient permissions
  • Conflicting software
Solutions:
  1. Try restarting your computer
    • Often resolves temporary issues
  2. Reinstall the application
    bash
    # Windows: Use Add/Remove Programs
# Mac: Delete from Applications and reinstall
# Linux:
sudo apt-get remove product-name
sudo apt-get install product-name
  3. Check system logs
    • Windows: Event Viewer > Application logs
    • Mac: Console.app
    • Linux: 
      /var/log/syslog
  4. Run as administrator (Windows only)
    • Right-click application icon
    • Select "Run as administrator"
症状： 双击图标后应用未启动
可能原因：
  • 安装文件损坏
  • 权限不足
  • 软件冲突
解决方案：
  1. 尝试重启电脑
    • 通常可解决临时问题
  2. 重新安装应用
    bash
    # Windows：使用添加/删除程序
# Mac：从应用程序文件夹删除后重新安装
# Linux:
sudo apt-get remove product-name
sudo apt-get install product-name
  3. 查看系统日志
    • Windows：事件查看器 > 应用程序日志
    • Mac：Console.app
    • Linux: 
      /var/log/syslog
  4. 以管理员身份运行（仅Windows）
    • 右键点击应用图标
    • 选择“以管理员身份运行”

Issue: Can't log in to my account

问题：无法登录账户

Symptoms: Login fails with "Invalid credentials" error
Solutions:
  1. Reset your password
    • Click "Forgot password?" on login screen
    • Enter your email address
    • Check email for reset link
    • Create new password
  2. Check Caps Lock
    • Passwords are case-sensitive
  3. Clear browser cache (web version)
    Chrome: Ctrl+Shift+Delete
Firefox: Ctrl+Shift+Delete
Safari: Cmd+Option+E
  4. Verify account is active
    • Check email for account verification
    • Contact support if account is suspended
症状： 登录时显示“凭据无效”错误
解决方案：
  1. 重置密码
    • 登录界面点击“忘记密码？”
    • 输入你的电子邮箱
    • 检查邮箱获取重置链接
    • 创建新密码
  2. 检查大小写锁定
    • 密码区分大小写
  3. 清除浏览器缓存（网页版）
    Chrome: Ctrl+Shift+Delete
Firefox: Ctrl+Shift+Delete
Safari: Cmd+Option+E
  4. 验证账户是否激活
    • 检查邮箱中的账户验证邮件
    • 若账户被冻结，请联系支持团队

Issue: Data not syncing

问题：数据未同步

Symptoms: Changes don't appear on other devices
Solutions:
  1. Check internet connection
  2. Verify sync is enabled
    • Settings > Sync > Enable sync
  3. Force sync
    • Click profile icon > Sync now
  4. Check sync status
    • Look for sync icon in bottom-right
    • Green = synced, Yellow = syncing, Red = error
症状： 修改内容未在其他设备显示
解决方案：
  1. 检查网络连接
  2. 验证同步是否启用
    • 设置 > 同步 > 启用同步
  3. 强制同步
    • 点击个人资料图标 > 立即同步
  4. 查看同步状态
    • 查看右下角的同步图标
    • 绿色=已同步，黄色=同步中，红色=同步错误

FAQ

常见问题

General Questions

一般性问题

Q: Is [Product Name] free?
A: [Product Name] offers both free and paid plans:
  • Free: Basic features, 1 project, 100 MB storage
  • Pro ($9.99/month): Unlimited projects, 100 GB storage, priority support
  • Enterprise: Custom pricing, dedicated support, SSO
Q: Can I use [Product Name] offline?
A: Yes, [Product Name] works offline. Changes sync when you reconnect.
Q: What platforms are supported?
A: Windows, macOS, Linux, iOS, Android, and web browsers.
问：[产品名称]是免费的吗？
答：[产品名称]提供免费和付费套餐：
  • 免费版： 基础功能，1个项目，100 MB存储空间
  • 专业版（9.99美元/月）： 无限项目，100 GB存储空间，优先支持
  • 企业版： 定制定价，专属支持，单点登录（SSO）
问：[产品名称]可以离线使用吗？
答：可以，[产品名称]支持离线使用。重新联网后会同步修改内容。
问：支持哪些平台？
答：支持Windows、macOS、Linux、iOS、Android以及网页浏览器。

Data and Privacy

数据与隐私

Q: Where is my data stored?
A: Data is stored on secure AWS servers in [region]. Enterprise customers can choose data location.
Q: Is my data encrypted?
A: Yes, all data is encrypted:
  • In transit: TLS 1.3
  • At rest: AES-256 encryption
Q: Can I export all my data?
A: Yes, go to Settings > Data > Export All Data.
问：我的数据存储在哪里？
答：数据存储在[地区]的安全AWS服务器上。企业客户可选择数据存储位置。
问：我的数据是否加密？
答：是的，所有数据均已加密：
  • 传输中：TLS 1.3
  • 存储时：AES-256加密
问：我可以导出所有数据吗？
答：可以，前往设置 > 数据 > 导出所有数据。

Support

支持

Getting Help

获取帮助

Documentation: https://docs.example.com
Community Forum: https://community.example.com
Email Support: support@example.com
  • Response time: 24 hours for Free, 4 hours for Pro, 1 hour for Enterprise
Live Chat: Available for Pro and Enterprise customers
  • Monday-Friday, 9 AM - 5 PM EST
Phone Support: 1-800-EXAMPLE (Enterprise only)
文档： https://docs.example.com
社区论坛： https://community.example.com
邮箱支持： support@example.com
  • 响应时间：免费版24小时，专业版4小时，企业版1小时
在线聊天： 专业版和企业版用户可用
  • 时间：周一至周五，美国东部时间上午9点至下午5点
电话支持： 1-800-EXAMPLE（仅企业版）

Reporting Bugs

提交Bug

Found a bug? Help us improve by reporting it:
  1. Go to Help > Report Bug
  2. Describe what happened
  3. Include steps to reproduce
  4. Attach screenshots if applicable
  5. Click Submit
发现Bug了？欢迎反馈帮助我们改进：
  1. 前往帮助 > 提交Bug
  2. 描述问题情况
  3. 提供复现步骤
  4. 如有需要，附上截图
  5. 点击提交

Feature Requests

功能请求

Have an idea? We'd love to hear it:
  1. Visit https://feedback.example.com
  2. Search existing requests
  3. Vote for existing ideas or submit new ones
有想法？欢迎告诉我们：
  1. 访问https://feedback.example.com
  2. 搜索已有请求
  3. 为已有想法投票或提交新请求

Version Information

版本信息

Current version: 2.5.0 Release date: January 15, 2025 View release notes
undefined
当前版本：2.5.0 发布日期：2025年1月15日 查看发布说明
undefined

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
  • 使用未解释的行话
  • 假设用户有前置知识
  • 跳过重要步骤
  • 使用过时截图
  • 大段无分段的文字
  • 版本更新后忘记更新文档
  • 过度简化复杂任务

Resources

资源