コンテンツへスキップ
ドキュメント

最適なテンプレートの選び方

Hintoでは、記事を効果的に構成するための多彩なテンプレートを用意しています。新しい記事を作成する際、テンプレートの選択画面が表示されます。各テンプレートは、ステップバイステップのガイドから概要説明まで、コンテンツの種類に合わせて設計されています。

詳細なハウツーガイド

最も頻繁に使用されるテンプレートです。特定のタスクをユーザーに実行してもらうための手順書作成に最適で、明快で実践的、かつ網羅的な構成になっています。

  • ステップバイステップの手順: 各アクションを番号付きリストで記載します。スクリーンショットやGIFを配置し、各工程を視覚的に説明できます。
  • トラブルシューティング: よくある問題とその解決策を記載するためのセクションです(任意)。
  • まとめ: 要点の振り返りや、関連する記事へのリンクを記載する結びのセクションです。
Documentation image

機能概要

製品ページのクイックツアーを作成したり、関連する複数の機能を一度に紹介したりする場合に適しています。お知らせ記事や入門ガイドに最適です。

  • 機能セクション: 各機能専用のブロックです。短い説明、ユーザーが実行できる主な操作、その他のオプションなどを記載します。
  • ビジュアル: 各セクションには、機能を説明するためのスクリーンショットや画像を配置できます。
Documentation image

ガイド付きレッスン

特定のトピックについて読者の理解を深める、レッスン形式のコンテンツに適したテンプレートです。トレーニング資料や詳細なチュートリアルに最適です。

  • コンセプトまたはアクションブロック: 詳細な説明や重要なポイントを交えてコンセプトを紹介するセクションです。
  • ハンズオン演習: レッスン内容の実践を促すセクションです(任意)。
  • 要点のまとめ: レッスンの中で最も重要な情報を補強します。
Documentation image

コンセプト解説

特定のコンセプトが「何であるか」「なぜ重要なのか」を説明する場合に選択してください。基礎知識の解説や用語集、製品の基本原則を説明する記事に最適です。

  • 概要: 平易な言葉での説明と主な特徴を記載するセクションです。
  • 重要性: そのコンセプトがどのようなメリットをもたらし、ワークフローや意思決定にどう役立つかを概説するセクションです。
Documentation image

基本ガイド

基本的な設定や、ユーザーの最初のステップを支援するためのシンプルで無駄のない構成です。クイックスタートガイドや、画像や詳細な説明を必要としない単純なプロセスの解説に最適です。

  • 番号付きステップ: 各手順の短い説明を含む、すっきりとしたステップバイステップ形式です。
  • ビジュアルなし: シンプルさを最大限に追求するため、あえてテキストのみで構成されています。
Documentation image

テンプレート選びのヒント

  • 手順を追うタスクには、詳細なハウツーガイドを使用します。
  • 全体的な製品ツアーには、機能概要を使用します。
  • 詳細なトレーニングコンテンツには、ガイド付きレッスンを選択します。
  • 用語や基本的な考え方を定義するには、コンセプト解説が最適です。
  • 非常にシンプルで素早い手順説明には、基本ガイドを使用します。

まとめ

この記事では、Hintoで利用可能な5種類の記事テンプレートの概要を紹介しました。詳細なハウツーガイドや機能概要、ガイド付きレッスン、コンセプト解説など、各テンプレートの目的を理解することで、コンテンツに最適な構造を選択でき、ドキュメントの明快さと有効性を高めることができます。

関連リンク