user-guide-writing
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseUser Guide Writing
用户指南撰写
When to use this skill
何时使用此技能
- 신규 기능: 사용자에게 새 기능 소개
- 온보딩: 신규 사용자 교육
- FAQ: 자주 묻는 질문 정리
- 新功能:向用户介绍新功能
- 新手指引:培训新用户
- FAQ:整理常见问题
Instructions
操作说明
Step 1: Quick Start Guide
步骤1:快速入门指南
markdown
undefinedmarkdown
undefinedGetting Started with MyApp
Getting Started with MyApp
Welcome to MyApp! This guide will help you get up and running in 5 minutes.
Welcome to MyApp! This guide will help you get up and running in 5 minutes.
Step 1: Create an Account
Step 1: Create an Account
- Go to https://myapp.com/signup
- Enter your email and create a password
- Password must be at least 8 characters
- Include uppercase, lowercase, and numbers
- Click "Sign Up"
- Check your email for verification link
- Click the link to verify your account

- Go to https://myapp.com/signup
- Enter your email and create a password
- Password must be at least 8 characters
- Include uppercase, lowercase, and numbers
- Click "Sign Up"
- Check your email for verification link
- Click the link to verify your account

Step 2: Complete Your Profile
Step 2: Complete Your Profile
- Click on your avatar in the top-right corner
- Select "Profile Settings"
- Add your name and profile picture
- Click "Save Changes"
- Click on your avatar in the top-right corner
- Select "Profile Settings"
- Add your name and profile picture
- Click "Save Changes"
Step 3: Create Your First Project
Step 3: Create Your First Project
- Click the "+ New Project" button
- Enter a project name
- Choose a template (or start from scratch)
- Click "Create"
🎉 Congratulations! You're ready to start using MyApp.
- Click the "+ New Project" button
- Enter a project name
- Choose a template (or start from scratch)
- Click "Create"
🎉 Congratulations! You're ready to start using MyApp.
Next Steps
Next Steps
- Watch the video tutorial
- Explore features
- Join our community
- Watch the video tutorial
- Explore features
- Join our community
Need Help?
Need Help?
- 📧 Email: support@myapp.com
- 💬 Live chat: Available 9 AM - 5 PM EST
- 📚 Help Center
undefined- 📧 Email: support@myapp.com
- 💬 Live chat: Available 9 AM - 5 PM EST
- 📚 Help Center
undefinedStep 2: How-To Guide (작업 중심)
步骤2:操作指南(任务导向)
markdown
undefinedmarkdown
undefinedHow to Export Your Data
How to Export Your Data
This guide shows you how to export all your data from MyApp.
This guide shows you how to export all your data from MyApp.
Before You Start
Before You Start
- Exporting data may take 5-10 minutes depending on size
- You'll receive an email when the export is ready
- Exported data is in JSON format
- Exporting data may take 5-10 minutes depending on size
- You'll receive an email when the export is ready
- Exported data is in JSON format
Step-by-Step Instructions
Step-by-Step Instructions
1. Navigate to Settings
1. Navigate to Settings
Click on your profile picture in the top-right corner and select Settings.

Click on your profile picture in the top-right corner and select Settings.

2. Go to Data Export
2. Go to Data Export
In the left sidebar, click on Privacy & Data.
Then scroll down to the Export Data section.

In the left sidebar, click on Privacy & Data.
Then scroll down to the Export Data section.

3. Request Export
3. Request Export
Click the Request Export button.
A confirmation dialog will appear:
Export Your DataWe'll send you an email with a download link when your export is ready. This usually takes 5-10 minutes.[Cancel] [Confirm]
Click Confirm to proceed.
Click the Request Export button.
A confirmation dialog will appear:
Export Your DataWe'll send you an email with a download link when your export is ready. This usually takes 5-10 minutes.[Cancel] [Confirm]
Click Confirm to proceed.
4. Check Your Email
4. Check Your Email
You'll receive an email at your registered address with subject:
"Your Data Export is Ready"
The email contains a secure download link that expires in 7 days.
You'll receive an email at your registered address with subject:
"Your Data Export is Ready"
The email contains a secure download link that expires in 7 days.
5. Download Your Data
5. Download Your Data
Click the download link in the email.
A ZIP file will be downloaded containing:
- - Your profile information
profile.json - - All your projects
projects.json - - Uploaded files
files/
Click the download link in the email.
A ZIP file will be downloaded containing:
- - Your profile information
profile.json - - All your projects
projects.json - - Uploaded files
files/
Troubleshooting
Troubleshooting
Problem: I didn't receive the email
- Check your spam folder
- Make sure your email is correct in Settings
- Try requesting again (you can request once per day)
Problem: Download link expired
- Request a new export from Settings
Problem: Export file is corrupted
- Try downloading again
- If issue persists, contact support@myapp.com
Problem: I didn't receive the email
- Check your spam folder
- Make sure your email is correct in Settings
- Try requesting again (you can request once per day)
Problem: Download link expired
- Request a new export from Settings
Problem: Export file is corrupted
- Try downloading again
- If issue persists, contact support@myapp.com
Related Guides
Related Guides
- How to Delete Your Account
- Privacy Policy
- Data Security
undefined- How to Delete Your Account
- Privacy Policy
- Data Security
undefinedStep 3: FAQ (자주 묻는 질문)
步骤3:FAQ(常见问题)
markdown
undefinedmarkdown
undefinedFrequently Asked Questions (FAQ)
Frequently Asked Questions (FAQ)
Account & Billing
Account & Billing
How do I change my email address?
How do I change my email address?
- Go to Settings > Account
- Click Change Email
- Enter your new email and password
- Click Update
- Verify your new email
- Go to Settings > Account
- Click Change Email
- Enter your new email and password
- Click Update
- Verify your new email
Can I use MyApp for free?
Can I use MyApp for free?
Yes! MyApp has a free tier that includes:
- Up to 3 projects
- 1 GB storage
- Basic features
Yes! MyApp has a free tier that includes:
- Up to 3 projects
- 1 GB storage
- Basic features
How do I cancel my subscription?
How do I cancel my subscription?
- Go to Settings > Billing
- Click Cancel Subscription
- Follow the prompts
Your subscription will remain active until the end of the billing period.
- Go to Settings > Billing
- Click Cancel Subscription
- Follow the prompts
Your subscription will remain active until the end of the billing period.
Features
Features
How do I collaborate with team members?
How do I collaborate with team members?
- Open your project
- Click the Share button
- Enter team member's email
- Choose their permission level (View, Edit, Admin)
- Click Send Invite
They'll receive an email invitation.
- Open your project
- Click the Share button
- Enter team member's email
- Choose their permission level (View, Edit, Admin)
- Click Send Invite
They'll receive an email invitation.
Can I export my projects?
Can I export my projects?
Yes, see our Export Guide.
Yes, see our Export Guide.
What file formats are supported?
What file formats are supported?
- Images: JPG, PNG, GIF, SVG
- Documents: PDF, DOCX, TXT, MD
- Code: All text files
- Images: JPG, PNG, GIF, SVG
- Documents: PDF, DOCX, TXT, MD
- Code: All text files
Technical
Technical
Is my data secure?
Is my data secure?
Yes! We use:
- 256-bit SSL encryption
- Regular security audits
- SOC 2 Type II certified
- GDPR compliant
Read our Security Page
Yes! We use:
- 256-bit SSL encryption
- Regular security audits
- SOC 2 Type II certified
- GDPR compliant
Read our Security Page
Can I use MyApp offline?
Can I use MyApp offline?
Currently, MyApp requires an internet connection. Offline mode is planned for Q2 2025.
Currently, MyApp requires an internet connection. Offline mode is planned for Q2 2025.
Browser compatibility?
Browser compatibility?
MyApp works best on:
- Chrome 90+
- Firefox 88+
- Safari 14+
- Edge 90+
MyApp works best on:
- Chrome 90+
- Firefox 88+
- Safari 14+
- Edge 90+
Still Have Questions?
Still Have Questions?
- 📧 Email: support@myapp.com
- 💬 Live Chat (9 AM - 5 PM EST)
- 🎓 Video Tutorials
- 👥 Community Forum
undefined- 📧 Email: support@myapp.com
- 💬 Live Chat (9 AM - 5 PM EST)
- 🎓 Video Tutorials
- 👥 Community Forum
undefinedStep 4: Tutorial (학습 중심)
步骤4:教程(学习导向)
markdown
undefinedmarkdown
undefinedTutorial: Build Your First Dashboard
Tutorial: Build Your First Dashboard
In this tutorial, you'll learn how to create a beautiful dashboard with charts and widgets.
Time: 15 minutes
Difficulty: Beginner
Prerequisites: MyApp account
In this tutorial, you'll learn how to create a beautiful dashboard with charts and widgets.
Time: 15 minutes
Difficulty: Beginner
Prerequisites: MyApp account
What You'll Build
What You'll Build


Step 1: Create a New Dashboard
Step 1: Create a New Dashboard
Click + New Dashboard and name it "Sales Dashboard".
Click + New Dashboard and name it "Sales Dashboard".
Step 2: Add a Chart Widget
Step 2: Add a Chart Widget
- Click Add Widget → Chart
- Select Bar Chart
- Configure data source:
- Data: Monthly Sales
- X-axis: Month
- Y-axis: Revenue
- Click Add to Dashboard

- Click Add Widget → Chart
- Select Bar Chart
- Configure data source:
- Data: Monthly Sales
- X-axis: Month
- Y-axis: Revenue
- Click Add to Dashboard

Step 3: Add a Stats Widget
Step 3: Add a Stats Widget
- Click Add Widget → Stat Card
- Choose metric: Total Revenue
- Set comparison: vs. Last Month
- Click Add to Dashboard
- Click Add Widget → Stat Card
- Choose metric: Total Revenue
- Set comparison: vs. Last Month
- Click Add to Dashboard
Step 4: Arrange Widgets
Step 4: Arrange Widgets
Drag and drop widgets to arrange them.
Pro Tip: Hold Shift while resizing for precise control.
Drag and drop widgets to arrange them.
Pro Tip: Hold Shift while resizing for precise control.
Step 5: Save and Share
Step 5: Save and Share
- Click Save Dashboard
- Click Share to invite team members
- Click Save Dashboard
- Click Share to invite team members
Next Steps
Next Steps
Now that you've created your first dashboard, try:
- Adding filters
- Scheduling reports
- Customizing themes
Now that you've created your first dashboard, try:
- Adding filters
- Scheduling reports
- Customizing themes
Congratulations!
Congratulations!
You've completed the tutorial. Happy dashboard building! 🎉
undefinedYou've completed the tutorial. Happy dashboard building! 🎉
undefinedOutput format
输出格式
docs/
├── getting-started.md # Quick start
├── how-to/
│ ├── export-data.md
│ ├── invite-team.md
│ └── create-project.md
├── tutorials/
│ ├── first-dashboard.md
│ └── advanced-features.md
├── faq.md
└── images/
├── signup.png
└── dashboard.pngdocs/
├── getting-started.md # Quick start
├── how-to/
│ ├── export-data.md
│ ├── invite-team.md
│ └── create-project.md
├── tutorials/
│ ├── first-dashboard.md
│ └── advanced-features.md
├── faq.md
└── images/
├── signup.png
└── dashboard.pngConstraints
约束条件
필수 규칙 (MUST)
必须遵守的规则(MUST)
- 스크린샷 포함: 시각적 가이드
- 단계별 지침: 1, 2, 3 형식
- 사용자 언어: 전문 용어 지양
- 包含截图:提供视觉指南
- 分步说明:采用1、2、3的格式
- 用户语言:避免使用专业术语
금지 사항 (MUST NOT)
禁止事项(MUST NOT)
- 기술 용어 남발: API, endpoint 등
- 긴 문단: 짧고 명확하게
- 滥用技术术语:如API、endpoint等
- 冗长段落:保持简短清晰
Best practices
最佳实践
- User-Centric: 사용자 관점으로 작성
- Show, Don't Tell: 스크린샷, GIF, 비디오
- Update Regularly: UI 변경 시 문서도 업데이트
- 以用户为中心:从用户视角撰写
- 可视化展示:使用截图、GIF、视频
- 定期更新:UI变更时同步更新文档
References
参考资料
Metadata
元数据
버전
版本
- 현재 버전: 1.0.0
- 최종 업데이트: 2025-01-01
- 호환 플랫폼: Claude, ChatGPT, Gemini
- 当前版本:1.0.0
- 最后更新:2025-01-01
- 兼容平台:Claude, ChatGPT, Gemini
태그
标签
#user-guides#tutorials#documentation#onboarding#how-to#FAQ#user-guides#tutorials#documentation#onboarding#how-to#FAQExamples
示例
Example 1: Basic usage
示例1:基础用法
<!-- Add example content here -->
<!-- 添加示例内容 -->
Example 2: Advanced usage
示例2:高级用法
<!-- Add advanced example content here -->
<!-- 添加高级示例内容 -->