Tutorial Design skill
Overview
This skill provides techniques for designing and creating effective tutorials that let users learn through practice. It supports users' skill acquisition through step-by-step learning, designing successful experiences, and using visual aids.
Step-by-step learning path design
3-level learning path model
Level 1: クイックスタート (5-10分)
├── 目的: 最初の成功体験を提供
├── 内容: 最小限の操作で達成可能なタスク
├── 成果: モチベーション構築
└── 例: 「5分で最初のワークフローを実行」
Level 2: Basic tutorial (20-30 minutes)
├── Purpose: Systematic learning of major features
├── Content: Mastering core features
├── Outcome: Completing practical tasks
└── Example: "Create a basic report"
Level 3: Advanced tutorial (60+ minutes)
├── Purpose: Mastering complex workflows
├── Content: Advanced features and combinations
├── Outcome: Understanding best practices
└── Example: "Build a custom dashboard"
### レベル別設計原則
| レベル | 前提知識 | 詳細度 | 視覚補助 | 成功基準 |
| ------- | ------------ | ------ | -------- | -------------- |
| Level 1 | なし | 最小限 | 必須 | 5 分以内で完了 |
| Level 2 | Level 1 完了 | 中程度 | 推奨 | 主要タスク達成 |
| Level 3 | Level 2 完了 | 詳細 | 任意 | 応用能力獲得 |
## ステップバイステップ構造
### ステップ設計原則
1. **1 ステップ 1 アクション**: 各ステップは単一の明確なアクションのみ
2. **番号付き**: すべてのステップに番号を付与
3. **動詞で開始**: 「クリックします」「入力します」「選択します」
4. **視覚的確認**: 各ステップの成功を確認できる方法を提示
### ステップ構造テンプレート
```markdown
### ステップ N: [アクションの目的]
[アクションの説明]
1. **[具体的なアクション]**
- 操作: [クリック/入力/選択]
- 場所: [UI 要素の特定]
- 値: [入力する値（該当する場合）]
2. **[次のアクション]**
...
💡 **ヒント**: [補足情報]
✅ **確認ポイント**: [成功時に表示される内容]
⚠️ **注意**: [よくある間違いや注意点]
Placement of supplementary elements
| Element |
Icon |
Usage scenario |
| Tip |
💡 |
Additional useful information |
| Checkpoint |
✅ |
How to confirm success |
| Warning |
⚠️ |
Points to note |
| Important |
🔴 |
Required precautions |
| Reference |
📚 |
Link to related information |
Prerequisites section design
Required elements
## はじめる前に
### 必要なもの
- [ ] [必要なアカウント/権限]
- [ ] [必要なソフトウェア/ツール]
- [ ] [必要なデータ/ファイル]
### 前提知識
- [理解しておくべき概念]
- [完了しておくべきチュートリアル]
### 所要時間
- 約 [X] 分
### 対象者
- [どのようなユーザー向けか]
Use of visual aids
Screenshot design
Placement principles
- Place immediately after the step: Place immediately after the action description
- Keep up to date: Match the current UI
- Highlighting: Emphasize the operation location with arrows or highlights
- With caption: Explain what is being shown
Annotation conventions
| Element |
Color |
Purpose |
| Arrow |
Red |
Indicate click location |
| Border |
Blue |
Emphasize the area of focus |
| Number |
Green |
Order of steps |
| Text |
Black |
Supplementary explanation |
Types of diagrams and how to use them
| Type |
Usage scenario |
Creation tool |
| Flowchart |
Overall picture of the process |
Mermaid |
| Screen transition diagram |
Flow of UI operations |
Figma/Draw.io |
| Conceptual diagram |
Explanation of relationships |
Mermaid |
| Comparison table |
Organizing options |
Markdown table |
Description of expected results
Explicit success criteria
## 完了後の状態
このチュートリアルを完了すると:
✅ [達成されること 1]
✅ [達成されること 2]
✅ [達成されること 3]
### 確認方法
[成功を確認する具体的な手順]
### 次のステップ
- [次に学ぶべきチュートリアル]
- [関連する高度なトピック]
Troubleshooting links
Error guidance patterns
## うまくいかない場合
### よくある問題
<details>
<summary>❓ [問題の症状]</summary>
**原因**: [問題の原因]
**解決方法**:
1. [解決手順 1]
2. [解決手順 2]
</details>
### 詳細なトラブルシューティング
- [トラブルシューティングガイドへのリンク]
- [サポートへの問い合わせ方法]
Tutorial completeness checklist
Structure check
- Are prerequisites explicitly stated?
- Is the required time stated?
- Is the target audience clear?
- Do all steps have numbers?
- Is each step one action?
Content check
- Are the step explanations specific?
- Are there visual aids (screenshots, etc.)?
- Is there a checkpoint for each step?
- Are expected results explicitly stated?
Usability check
- Is the language understandable to beginners?
- Are technical terms explained?
- Is there guidance for errors?
- Is there guidance to the next step?
Resource references
| Resources |
Path |
Content |
| Completion time estimate |
.claude/skills/tutorial-design/scripts/estimate-completion-time.mjs |
Calculate required time from the number of steps |
| Tutorial template |
.claude/skills/tutorial-design/templates/tutorial-template.md |
Standard tutorial structure |
| Learning path design guide |
.claude/skills/tutorial-design/resources/learning-path-design.md |
Detailed design for step-by-step learning |
Related skills
.claude/skills/user-centric-writing/SKILL.md: User-centered writing.claude/skills/troubleshooting-guides/SKILL.md: Troubleshooting design.claude/skills/information-architecture/SKILL.md: Documentation structure design
