Help Article Writer

ヘルプ記事ライター

複雑な製品知識を、明確で要点を把握しやすく、ユーザーにとって使いやすいドキュメントに変換する、ヘルプセンターコンテンツ作成のエキスパートシステムです。このスキルは、ユーザーが成果を上げるために実際に役立つヘルプ記事を計画、執筆、書式設定、最適化するための体系的なワークフローを提供します。

ヘルプ記事は、製品とユーザーの成功をつなぐ架け橋です。質の高いドキュメントは、サポートの負担を軽減し、ユーザーの利用開始を促進し、製品への信頼を築きます。このスキルを使うと、ユーザーが見つけ、理解し、行動に移せるヘルプコンテンツを作成できます。

テクニカルライティングのベストプラクティスとユーザーエクスペリエンスの原則に基づき、このスキルではコンテンツ戦略、明快な文章、継続的な最適化を組み合わせ、拡張性のあるヘルプセンターを作成します。

主なワークフロー

ワークフロー 1：コンテンツの計画

ドキュメント化が必要な内容を整理し、優先順位を付けます

1. コンテンツ監査

   • 既存のヘルプコンテンツを一覧化する
   • 製品機能に対する不足箇所を特定する
   • 更新が必要な古いコンテンツに印を付ける
   • コンテンツをユーザージャーニーに対応付ける
   • サポートチケット数に基づいて優先順位を付ける

2. ユーザージャーニーのマッピング

   • 主要なユーザーフローを記録する
   • ガイダンスが必要な判断ポイントを特定する
   • ドキュメントが必要となる複雑な箇所を記録する
   • オンボーディングに必要なドキュメントを整理する
   • 機能の利用促進目標に合わせる

3. コンテンツ階層

   • はじめに：初めて利用するユーザー向け
   • 主要機能：主な機能のガイド
   • 高度な機能：上級ユーザー向けドキュメント
   • インテグレーション：サードパーティとの連携
   • アカウントと請求：管理に関する情報
   • トラブルシューティング：問題の解決

4. 優先度マトリックス

   優先度	基準
   最優先	チケット数が多い、主要機能、オンボーディング
   高	チケット数が中程度、重要な機能
   中	チケット数が少ない、あると便利な機能
   低	例外的なケース、ほとんど使われない機能

ワークフロー 2：記事の構成

記事を、要点を把握しやすく理解しやすい構成にします

1. 標準的な記事テンプレート

   # [Clear, Action-Oriented Title]
   
   [One-sentence summary of what this article covers]
   
   ## Overview
   [Brief context - what, why, who needs this]
   
   ## Prerequisites
   [What users need before starting - optional]
   
   ## Steps / How It Works
   [Numbered steps or explanation]
   
   ## Examples
   [Concrete examples if helpful]
   
   ## Common Issues
   [Troubleshooting section if relevant]
   
   ## Related Articles
   [Links to related content]
   

2. 記事の種類

   • 概念解説：あるものが何であり、なぜ重要なのかを説明する
   • 手順ガイド：手順を追って操作方法を説明する
   • リファレンス：技術仕様、API ドキュメント
   • トラブルシューティング：問題と解決策の形式
   • チュートリアル：学習を目的とした手順ガイド

3. 書式設定の基準

   • H1 はタイトルのみに使用する
   • H2 は大見出しに使用する
   • H3 は小見出しに使用する
   • 順序のある手順には番号付きリストを使用する
   • 順序のない項目には箇条書きを使用する
   • 警告、ヒント、注記にはコールアウトを使用する

ワークフロー 3：執筆プロセス

ユーザーを中心とした明快なコンテンツを作成します

1. 執筆前の準備

   • ユーザーとその目標を定義する
   • ユーザーが最初に持っている知識を特定する
   • 成功の基準を決める
   • 技術情報を集める
   • 自分で手順を試す

2. 下書き

   • 機能ではなく、ユーザーの目標から書き始める
   • 二人称（「あなた」）で書く
   • 能動態を使う
   • 1文を25語未満にする
   • 1段落につき1つの考えを述べる
   • 最初に行動を示す

3. 編集の各段階

   • 明確さの確認：専門用語を簡単にし、文を短くする
   • 正確さの確認：すべての手順が機能することを検証する
   • 書式の確認：見出し、リスト、コールアウトを追加する
   • リンクの確認：内部リンクと外部リンクを追加する
   • ビジュアルの確認：スクリーンショットや図を追加する

4. 品質チェックリスト

   • タイトルに、ユーザーが達成できることが明確に示されている
   • 概要で2～3文にまとめて背景を説明している
   • 手順に番号が付いており、具体的である
   • スクリーンショットに最新の UI が表示されている
   • 説明のない専門用語がない
   • よくある問題のトラブルシューティングが含まれている
   • 関連コンテンツへのリンクがある
   • 専門知識のないユーザーが試している

ワークフロー 4：ビジュアルコンテンツ

効果的な画像で記事を充実させます

1. スクリーンショットのガイドライン

   • 関連する UI 領域のみをキャプチャします
   • 使用するブラウザーとデバイスを統一します
   • 番号付きの吹き出しで注釈を付けます
   • クリック可能な要素を強調表示します
   • サイズを統一します
   • UI が変更されたら更新します

2. 図のガイドライン

   • 複雑なフローやアーキテクチャに使用します
   • ビジュアルスタイルを統一します
   • 必要に応じて凡例を含めます
   • 小さいサイズでもテキストを読みやすくします
   • アクセシビリティのために代替テキストを用意します

3. 動画のガイドライン

   • 3 分未満にします
   • 複雑で複数の手順があるプロセスに使用します
   • 字幕を付けます
   • テキストによる代替手段を用意します
   • 信頼できるプラットフォームでホストします

4. ビジュアルの配置

   • スクリーンショットは、説明する手順の後に配置します
   • 図は、概念を初めて紹介する箇所に配置します
   • 動画は任意の補足として使い、代替にはしません

ワークフロー 5：最適化とメンテナンス

コンテンツを新鮮で効果的な状態に保ちます

1. SEO の最適化

   • タイトルと見出しにキーワードを含めます
   • 内容が伝わるメタディスクリプションを書きます
   • 自然な言葉遣いにします（検索クエリに合致するようにします）
   • 内部リンクの構造を整えます
   • 画像に代替テキストを付けます

2. 分析データの追跡

   • ページビュー数とユニーク訪問者数
   • ページ滞在時間
   • 直帰率
   • 記事につながった検索語句
   • 「役に立ちましたか？」のフィードバック
   • サポートチケットへの遷移率

3. 更新のきっかけ

   • 製品 UI の変更
   • 機能の更新または廃止
   • ユーザーからのフィードバックで混乱が示された場合
   • サポートチケットの傾向
   • 役立ち度の評価が低い場合

4. レビューの頻度

   • リリース時：影響を受ける記事を更新します
   • 毎月：フィードバックと指標を確認します
   • 四半期ごと：コンテンツを包括的に監査します
   • 毎年：必要に応じて全面的に再構成します

クイックリファレンス

アクション	コマンド／トリガー
ヘルプコンテンツを計画する	"Create help center content plan"
新しい記事を書く	"Write help article for [feature]"
既存の記事を改善する	"Optimize help article for [topic]"
スクリーンショットのガイドを作成する	"Generate screenshot guidelines"
ヘルプコンテンツを監査する	"Audit help center coverage"
記事を簡潔にする	"Simplify article for [topic]"
トラブルシューティングを追加する	"Add troubleshooting to [article]"
動画の台本に変換する	"Create video script from [article]"
記事の指標を確認する	"Analyze help article performance"
記事シリーズを作成する	"Create article series for [workflow]"

ベストプラクティス

文体

• 中学 2 年生が読める程度のレベルで書きます
• 専門用語よりもなじみのある言葉を使います
• 略語は初出時に定義します
• 1 つの手順につき指示は 1 つにします
• 手順は動詞で始めます
• 「簡単」「ただ」「楽々」といった表現は避けます

構成

• 最も重要な情報を冒頭に置きます
• 記事のテーマを 1 つに絞ります
• リストの構造を統一します
• 入れ子は 2 階層までにします
• 長い記事にはページ内リンクを含めます

ユーザーエクスペリエンス

• 検索で記事を見つけられるようにします
• 複数のナビゲーション経路を用意します
• パンくずリストを含めます
• 関連コンテンツにリンクします
• フィードバック機能を有効にします
• サポートへのエスカレーション経路を用意します

アクセシビリティ

• すべての画像に代替テキストを付けます
• 内容が分かるリンクテキストを使います（「ここをクリック」は避けます）
• 十分な色のコントラストを確保します
• キーボードで操作できるようにします
• スクリーンリーダーに対応させます
• 動画に字幕を付けます

メンテナンス

• 記事の担当者を割り当てます
• 製品変更の際に更新アラートを作成します
• コンテンツの鮮度を示す日付を追跡します
• 削除するのではなく、アーカイブします
• 重要な記事はバージョン管理します

記事テンプレート

手順記事

# How to [Accomplish Specific Goal]

Learn how to [brief description of what user will accomplish].

## Overview

[2-3 sentences explaining what this feature/process does and why a user would want to do this]

## Before You Start

- [Prerequisite 1]
- [Prerequisite 2]

## Steps

### Step 1: [Action]

[Explanation of what to do]

![Screenshot with annotation]

### Step 2: [Action]

[Explanation of what to do]

### Step 3: [Action]

[Explanation of what to do]

## Verify It Worked

You'll know you're successful when [observable outcome].

## Troubleshooting

**Issue**: [Common problem]
**Solution**: [How to fix it]

## What's Next

- [Related action 1]
- [Related action 2]

---
*Last updated: [Date] | [Feedback link]*

概念記事

# Understanding [Concept]

[One-sentence definition of the concept]

## What Is [Concept]?

[2-3 paragraphs explaining the concept in user terms]

## Why It Matters

[Explain the benefit to the user - what problem it solves]

## How It Works

[Explain the mechanism at appropriate technical level]

![Diagram if helpful]

## Key Terms

| Term | Definition |
|------|------------|
| [Term 1] | [Definition] |
| [Term 2] | [Definition] |

## Examples

### Example 1: [Scenario]
[Concrete example of concept in action]

### Example 2: [Scenario]
[Another example]

## Related Topics

- [Related concept 1]
- [Related concept 2]

---
*Last updated: [Date] | [Feedback link]*

トラブルシューティング記事

# Fixing [Problem Description]

Having trouble with [problem]? Here's how to resolve it.

## Symptoms

You might see this issue if:
- [Symptom 1]
- [Symptom 2]
- [Symptom 3]

## Quick Fixes

Try these solutions in order:

### Solution 1: [Most Common Fix]

[Steps to try]

### Solution 2: [Second Most Common]

[Steps to try]

### Solution 3: [Less Common]

[Steps to try]

## Still Having Issues?

If none of the above worked:

1. [Gather this information]
2. [Contact support] with details

## Why This Happens

[Brief technical explanation for curious users - optional]

## Prevent It in the Future

[Tips to avoid this issue - if applicable]

---
*Last updated: [Date] | [Feedback link]*

注意すべき点

• テキストの壁：見出し、箇条書き、視覚的な区切りがない
• 受動態：「ボタンをクリックする必要があります」ではなく、「ボタンをクリックしてください」
• 機能中心：ユーザーの目標ではなく、機能について説明している
• 古いスクリーンショット：UI が現在の製品と一致していない
• コンテキスト不足：ユーザーが多くの知識を持っていることを前提としている
• 次の手順がない：ユーザーが行き詰まっても、次に何をすべきかわからない
• 答えが埋もれている：重要な情報が文章の中に隠れている

コンテンツスタイルガイド

文体とトーン

• 親しみやすく、くだけすぎない
• 自信を持ちつつ、傲慢にならない
• 役立つ内容にしつつ、見下した言い方をしない
• 明確にしつつ、単純化しすぎない

単語の選び方

使用する	避ける
選択する	セレクトする
クリックする	押す（マウスの場合）
入力する	打ち込む
～に移動する	ナビゲートする
確認する	確実にする
使用する	活用する

書式

• ユーザーが操作する UI 要素には 太字 を使用する
• Code formatting は、ユーザー入力、コード、パスに使用する
• 強調には イタリック を控えめに使用する
• 重要な注意事項には > 引用ブロックを使用する