⚙️テクニカルコンテンツを書く
Mailchimpでは、主にガイドやチュートリアルでテクニカルコンテンツを掲載しています。このセクションでは、テクニカルコンテンツの基本的な考え方、テクニカルコンテンツの主な種類、テクニカル記事の書き方や編集方法について説明します。
基本
テクニカルコンテンツを読むほとんどの人は、特定の質問に対する答えを探しています。質問はざっくりしたものやピンポイントのものなど様々ですが、どちらにしても、私たちのゴールは、すっきりとすぐに答えを見付けられることです。
プロジェクトごとに、オーディエンスの背景、目的、現在の気持ちについて考えます。以下のような質問をしてみてください。
- 読者は見込みユーザーですか？新規ユーザーですか？それとも経験豊富なユーザーですか？
- ユーザーのゴールは何ですか？タスクを完了することですか？特定のトピックのリサーチですか？
- ユーザーはタスクの途中ですか？急いでいますか？イライラしている可能性はありますか？
不要な情報、選択肢、複雑なアイデア、フレーズなどで、オーディエンスに負担を掛けたくはありません。これは、ユーザーが初めての場合やイライラしている場合に特に重要です。
必要に応じて、最初の段落やセクションで、記事のアウトラインを簡潔に紹介し、そのトピックから外れることがないようにします。文章、段落、手順も、ぶれることなく簡潔さを保ってください。
テクニカルコンテンツの種類
テクニカルコンテンツの記事は、対象読者、ゴール、およびトーンによってそれぞれ異なります。Mailchimpのテクニカルコンテンツは、さまざまなゴールや読者に役立つテンプレートを使って作成されています。テンプレートは単にガイドラインとして使用し、絶対的なものとは考えません。読者に最適なコンテンツを提供するために、テンプレートから離れたり、複数のテンプレートの要素を組み合わせることもあります。
ここでは、私たちが使用している記事テンプレートの例をご紹介します。
記事テンプレート | ユーザーのタイプ | ゴール |
パスファインダー（道しるべ） | 見込み、新規、中級 | オリエンテーション トピックをまとめて、関連性のあるチュートリアルや一般的な参照ページへのリンクを提供します。 |
一般参照ページ | 見込み、新規、中級 | イントロダクション その機能が何であるか、どのように動作するのか、ユーザーにとってのメリットなどを詳細に説明します。また、関連したチュートリアルへのリンクを含めます。 |
困ったときは | 新規、中級、上級 | サポート 本来の動作の説明と、予期しない動作の潜在的な原因を含めます。原因またはトピックごとにグループ分けします。 |
チュートリアル | 新規、中級 | ガイダンス タスクを簡潔に説明します。ロードマップ、前提条件、ひとつひとつの手順を明確に説明します。 |
ガイドライン
テクニカルコンテンツを書く
テクニカルコンテンツを書く際は、「声(ボイス)&トーン」および「文法と表記ルール」セクションに書かれたスタイルのヒントに従います。ここでは他にも、いくつかのゴールと留意すべきポイントを紹介します。
タイトルとの関連性を保つ
記事のタイトルをクリックするとき、ユーザーは欲しい答えが見つかることを期待します。タイトルやトピックから内容が離れすぎないようにしましょう。リンクを使用して、関連するコンテンツを利用できるようにしましょう。意図したトピックから離れすぎていることに気付いた場合は、別の関連記事を作成する必要があるかもしれません。
見出しや段落は短く、さっと読めるようにする
明確な疑問を抱いているユーザーは、その答えが含まれる部分を探してさっと目を通すことがあります。さっと目を通しやすいように、ヘッドラインは短く、説明的で、内容に沿っていることを確認してください。
二人称を使用してユーザーにアクションを説明する
テクニカルコンテンツは、サポートスタッフが対応できないときにユーザーに語りかけます。
簡潔さと明快さを追求する
できる限りコンテンツを明確にしてください。シンプルな言葉とフレーズを使用し、動名詞や理解しづらい慣用句や熟語は避けましょう。ひとつの段落に含める文の数を制限して、タスクに集中してください。珍しいケースや、ある部分にだけ関連する情報を含める必要がある場合は、「お読みになる前に」リストや「注記」欄に、分けて記載しましょう。
埋め込んだスクリーンショット、動画、GIFを通じて、コンテキストを提供する
スクリーンショット、動画、GIFは、すべての記事やプロセスに必要なものではないかもしれませんが、新しいユーザーをガイドするのに役立ちます。読者が、手順を説明する部分に集中できるように、スクリーンショットをしっかりとトリミングしてください。
テクニカルコンテンツの書式を整える
テクニカルコンテンツは、構成、キャピタライゼーション、その他のフォーマットを使用して、意味を伝えやすくします。記事ごとに構成は異なっていても、書式に関するヒントは、すべててのテクニカルコンテンツで一貫しています。
キャピタライゼーション
Mailchimpの製品、機能、ページ、ツール、用語について記載する場合は、大文字、小文字を正しく使い分けましょう。手順を説明する際には、アプリに表示されるナビゲーションとボタンのラベルの語頭を大文字にし、ラベル全体を太字にします。
- Mailchimp
- Compliance Team（コンプライアンスチーム）、Billing Team（請求書管理チーム)
- Navigate to the Reports page.（レポートページへのナビゲーション)
- Click Create.（作成をクリック）
見出し
H2やH3を使用して、記事の内容を整理します。より高いレベルのトピックやゴールにはH2を使用し、各セクション内のサポート情報やタスクにはH3を使用します。
記事タイトル：ランディングページについて
- H2：Mailchimpでのランディングページの仕組み
- H2：ランディングページの使い方
- H2：リソース ・H3：インスピレーションを得て、ベストプラクティスを学ぶ ・H3：ランディングページを作成する ・H3：レポートについて学ぶ
番号付きリスト
手順の説明には、番号付きリストのみを使用します。手順を論理的なまとまりに分け、ひとつの手順に含まれるアクションは２つまでにします。補足説明やスクリーンショットが必要な場合は、リストの項目内で改行してください。
番号なしリスト
例や複数の注意書きを表すときには、番号なしのリストを使用します。リストの項目が10個以上の場合は、代わりにテーブル(表)を使用してください。
Last modified 2yr ago