スタイルガイド

ロケール：en-US

使用例：SaaS B2B製品 – ヘルプセンターとUI

# スタイルガイド：EN-US – ヘルプセンターの記事

## 1.目的と範囲

このスタイルガイドは、**英語（アメリカ合衆国）**のすべての**ヘルプセンター文書**の執筆基準を定義します。

これは次のことに適用されます：

- ハウツー記事  
- 機能説明  
- トラブルシューティングガイド  
- FAQエントリー  

**対象者：** 技術的およびビジネスの役割を持つプロフェッショナルなSaaSユーザー  
**目標：** ユーザーが迅速に、自信を持って、混乱なくタスクを完了できるように支援します。

---

## 2.声とトーン

ヘルプセンターのコンテンツは次のように聞こえるべきです：

- **明確でプロフェッショナル**
- **サポート的で解決志向**
- **自信に満ちていて、宣伝的でない**

私たちは、ユーザーが成功するためのガイドとして書きます — マーケティングコピーとしてではありません。

### トーンの原則

| 行う | 行わない |
|---|------|
| 冷静かつ直接的である | 過度にカジュアルまたはおしゃべりである |
| 次のステップに焦点を当てる | 何が間違ったかだけに焦点を当てる |
| ニュートラルな言語を使用する | 皮肉やユーモアを使う |

**例**

- ✅ 「接続が失敗した場合は、APIトークンを確認して再試行してください。」 
- ❌ 「あなたのトークンは間違っています。」修正してください。

---

## 3.文法とライティングスタイル

### 3.1 読者に直接話しかける

指示を明確にするために**あなた**を使用する。

- ✅ 「管理者ページからユーザーを管理できます。」 
- ❌ 「ユーザーは管理者ページから管理できます。」

---

### 3.2 能動態を好む

能動態は短く、理解しやすい。

- ✅ 「**変更を保存**を選択してください。」 
- ❌ 「変更を保存する必要があります。」

---

### 3.3 文を簡潔に保つ

- **25語以下**を目指す
- 1文につき1つの主なアイデア
- 長い説明はステップや箇条書きに分ける

---

### 3.4 明確な言葉を使う

不必要な複雑さを避ける。

- ✅ 「新しいプロジェクトを開始する。」 
- ❌ 「新しいプロジェクトの作成を開始する。」

---

## 4.用語と一貫性

### 4.1 承認された用語を使用する

製品名や機能名は定義された通りに正確に使用する。

- 大文字の使用を一貫させる  
- 重要な概念の同義語を作成しない  

**例**

- ✅ 「ワークスペース」  
- ❌ 「スペース」、「プロジェクトエリア」、「環境」

---

### 4.2 一般的でない略語を定義する

一般的な用語（API、URL）は定義する必要はない。 
内部または一般的でない略語は初回使用時に説明する必要がある。

- ✅ 「シングルサインオン（SSO）」  
- ❌ 文脈なしの「SSO」

---

### 4.3 米国英語の慣習

常に**en-USのスペル**を使用してください。

- ✅ “customize,” “behavior”  
- ❌ “customise,” “behaviour”

---

## 5.フォーマットとMarkdownの基準

### 5.1 見出し

明確でタスクベースの見出しを使用してください。

- ✅ “パスワードをリセットする”  
- ❌ “パスワードリセットプロセスの概要”

見出しの階層：

- `#` 記事のタイトル  
- `##` メインセクション  
- `###` 必要な場合のみサブセクション  

---

### 5.2 リスト

シーケンスには番号付きリストを使用してください：

1.**設定**を開く  
2.**請求**を選択  
3.**プランの変更**を選択してください  

オプションには箇条書きを使用してください：

- 管理者はユーザーを管理できます  
- 編集者はコンテンツを更新できます  

---

### 5.3 UI要素

UIラベルを一貫してフォーマットしてください：

- ボタン：**太字**
- ナビゲーションパス：矢印を使用

例：

**設定 → 請求 → プランの変更**に移動します。

---

### 5.4 リンク

リンクは目的地を説明する必要があります。

- ✅ 「請求ガイドを見る」  
- ❌ 「ここをクリック」

---

## 6.標準記事構造

すべてのヘルプセンターの記事はこの構造に従うべきです：

### 1.概要

1～2文で結果を説明してください。

> この記事では、サブスクリプションプランを変更する方法を説明します。

---

### 2.前提条件（任意）

要件を事前にリストアップしてください。

- 管理者権限  
- アクティブなサブスクリプション  

---

### 3.ステップバイステップの指示

ステップは次のようにするべきです：

- アクション指向  
- ステップごとに1つのアクション  
- コマンドとして書かれる  

例：

1.**設定**に移動します。 
2.**請求**を選択します。 
3.**プランを変更**を選択します。 

---

### 4.期待される結果

ユーザーに何が起こるべきかを伝えてください。

> 新しいプランは確認後すぐに有効になります。

---

### 5.次のステップ（オプション）

関連するアクションやリンクを提供します。

- 請求書を管理する  
- 支払い方法を更新する  

---

## 7.トラブルシューティングとエラー

### 7.1 安心させる

- ✅ 「接続できませんでした。」再試行してください。」 
- ❌ 「接続に失敗しました。」重大なエラー。」

---

### 7.2 解決策に焦点を当てる

ユーザーが次に何をすべきかを常に含める。

- 認証情報を確認する  
- 権限を確認する  
- 必要に応じてサポートに連絡する  

---

### 7.3 ユーザーを責めない

次のような言葉を避ける：

- 「あなたは何か間違ったことをしました」  
- 「無効な入力」（説明なし）

推奨：

> 「トークンが期限切れの可能性があります。」新しいものを生成して再試行してください。

---

## 8.実施 / 非実施の要約

### 実施すべきこと

- タスクに焦点を当て、ステップに基づいたコンテンツを書く  
- 一貫した用語を使用する  
- 文を短く、直接的に保つ  
- 説明的な見出しとリンクを使用する  
- 落ち着いた、支援的なトーンを維持する  

### 実施すべきでないこと

- マーケティング用語を追加する  
- イディオムやスラングを使用する  
- 同じ概念の用語を混ぜる  
- トラブルシューティングでユーザーを非難する  
- 構造のない長い段落を書く  

---

## 例（推奨）

プランを変更するには：

1.**設定 → 請求**に移動する  
2.**プラン変更**を選択する  
3.オプションを選択し、**確定**を選択する