開始する前にあなたの聴衆を知る

説明をする前に、まず説明している人を理解しなければなりません。 REST API の同じ説明は、非技術的なステークホルダーと、中立開発者がベテランの建築家を巻き込んだときに完全に異なる音になります。 まずは尋ねてから始めましょう: ベースラインの知識は何ですか? 彼らはこの情報で達成しようとしているものは何ですか? 一般的な誤解はすでに保持している可能性がありますか?

聴衆が少し技術的な背景を持っている場合は、 “サーバー” や “キャッシュ” などの基本的な用語に精通しを避ける。一見簡単な概念でも迅速な定義を提供。逆に、経験豊富な開業医に話している場合は、基礎的な詳細をスキップして、説明を効率的に保ちます。有用な技術は、あなたの聴衆の精神的な「知識マップ」を作成することです。その後、あなたの言語をそれに応じて調整します。

聴衆に適応する失敗は、技術的なコミュニケーションの最も一般的な下落の1つです。 リスナーや読者の開始点を診断することで、説明の深さ、ペース、および語彙を調整することができます。 この初期投資は、より少ないフォローアップ質問とより良い保持で支払います。

簡単な言語とアナログを使用する

ジャーゴンと頭字語は、すぐにオーディエンスを外すことができます。 可能な限り、専門用語を日常的な言葉に置き換えます。 例えば、「非同期イベント主導アーキテクチャ」と言い換えるのではなく、あなたは「タスクが独立して起こるシステムであり、信号を送信することによって通信」と言うかもしれません。 技術的な用語を使用する場合、短い明確な定義を提示します。

アナログは、非慣れな人と親しんでいる間のギャップを埋めるための最も強力なツールの一つです。 パイプがチャネル、水がデータであり、弁はスロットルまたはレートリミッターです。 このようなアナログは、固執する鮮やかな精神的なイメージを作成します。 しかし、アナログを遠くに伸ばすことは注意しないでください。すべてのメタファーは、いくつかの点で破壊します。 常に新しい誤解を導入することを避けるために制限に注意してください。

もう一つの効果的な方法は、[metaphorチェーンを使用することです。簡単な比較で始まり、説明が成長するにつれてそれに基づいて構築されます。たとえば、クラウドコンピューティングを「クラウドは電力網のようなもの」と説明し、仮想サーバーに「スカイスクレーパーのアパート」としてドリルし、最終的に「システム指向トラフィック」としてロードバランスを議論する。

より小さな部品に情報を破壊する

複雑なアイデアは、一頭のグルッペではほとんど理解されていません。 概念を消化可能なチャンクに分解し、各建物は、以前のものの上に論理的に。 このモジュラーアプローチは、私たちの脳が自然に新しい情報を処理する方法を反映しています。 短期記憶は、一度に約4〜7個のアイテムを保持することができます。 小さな手順で情報を表示することにより、あなたは認知限界を尊重します。

数値化されたステップや箇条書きを使用して、シーケンスを整理します。例えば、データベースのインデックスの仕組みを説明すると、次のようになります。

  • インデックスなしでどのようなデータが見えるか(フルテーブルスキャン)。
  • インデックスがより小さい検索構造(書籍のインデックスのような)を作成する方法。
  • データベースがインデックスを使用して行をすばやく検索する方法。
  • トレードオフ:読み込みが高速化、書き込みが遅くなる、追加のストレージ。

各チャンクは自在に汚染されるべきです。各セグメントにミニ・スモーリまたは次の部分につながるトランジション・ステートメントを埋めます。このスキャフォールディングは、紛失や圧倒を感じずに、オーディエンスが完全な写真を組み立てるのに役立ちます。

ビジュアルエイドとダイアグラムを使用する

絵は、抽象的な技術的なプロセスを記述するときに、特に、千の言葉の価値があります。視覚表現は、明確で直観的なレイアウトに、具体的な関係を変形させることができます。図、フローチャート、システムアーキテクチャの図面、さらにはホワイトボードのヘルプ学習者に対する簡単なスケッチは、アイデアの構造を見ることができます。

視覚設計するときは、明確さの基本的な原則に従います:

  • ラベルの部品は明らかに。
  • 矢印を使用して、データや制御フローの方向を示します。
  • 各図を1つのメインコンセプトに限定します。
  • 関連する要素に一貫性のあるカラーコーディングを使用します。

デジタル文書については、 ] draw.io や ] などのツールを使用して、プロの図を生成します。 インタラクティブな図は、ユーザーがより詳細を明らかにするためにクリックできる、特にオンラインチュートリアルでは有効です。 単純前後図でさえ、最適化なしでプロセスを表示し、それで - 明らかな技術的な解決策の利益を作ることができます。

リアルワールドの事例を提供

よくあるコンテキストに結び付けられたとき、抽象的な概念はコンクリートになります。 抽象的な「キャッシュ」を説明する代わりに、キッチンのパントリーがどのように機能するかを記述します。 頻繁に使用される成分を腕の手の届く範囲内で保持しますが、一般的な項目は地下室ストレージにとどまります。 同様に、Webブラウザは、訪問の負荷を繰り返すように、画像とスクリプトをキャッシュします。

アルゴリズムについて議論するときは、日常のシナリオを使用してください。オーディエンスにカードのデッキを整理することを想像してもらうように依頼することで、「解決」を説明します。 「再帰」は、古典的なロシアのネスティング人形(マトリオシュカ)を介して、または同じ問題のより小さなバージョンを解決することによって問題の解決の概念を介して導入することができます。 これらの具体的な参照は、既存の精神モデルに新しい知識を固定します。

もう一つの強力な技術は、[]の作業例を歩くことです。 DevOpsパイプラインをインストールしたり、正確なコマンド、出力、および結果がステップバイステップで示すような技術的な手順のために。 作業例は、認知負荷を減らし、初心者がそれ自体を試みる前に、推論プロセスを観察することができます。

質問とフィードバックを奨励

技術的な説明は、片道の放送であるべきではありません。 質問、声の混乱、または課題の仮定を求めるために、あなたの聴衆のためのスペースを作成してください。 ライブ設定では、頻繁に一時停止し、質問を招待します。 書面で、 "一般的な質問"セクションまたはフィードバックフォーム。

アクティブリスニングは、同様に重要です。 誰かが質問をすると、自分が本当に尋ねているものを理解するために、あなた自身の言葉でそれを休息させます。 多くの場合、説明者は学習者が持っていたものよりも異なる質問に答えたので、技術的な説明は失敗します。 診断ツールとして質問を使用してください。 説明のどの部分が改善を必要とするかを明らかにします。

より大きい聴衆のために、 ]]のような用具はSlido[]または生きている気孔は無声質問に直面できます。 文書では、各セクションの最後に「この有用か?」ウィジェットを追加することで、理解に対する直接フィードバックが得られます。 効果的なコミュニケーションが反復的であることを覚えておいてください。 フィードバックループは、リアルタイムでアプローチを調整するのに役立ちます。

重要なポイントをまとめ、コアのアイデアをリテ

すべての説明の最後に、必要な部分に戻って円を回します。短い要約は、学習したものを整理し、最も重要なテイクアウトを強化するのに役立ちます。主要なアイデアの明確で思い出に残る安静を使用してください。誰でも繰り返すことができる明白な言語で。

例えば、ロードバランシングの説明をした後、次のようにまとめるかもしれません。「ロードバランサーは、Webリクエストのトラフィックコプのようなものです。複数のサーバー間でトラフィックを分散させ、単一のサーバーが圧倒的になれるのを防ぎ、アプリケーションを迅速かつ信頼性のある状態に保ちます。このワン・ステンス・リキャップは、それを優先する詳細な説明よりもはるかに簡単にリコールできます。

また、「1ページ」のチートシートや、コンセプト全体を一目で捉える簡単な図を提供すると考えてください。 要約は、新しい情報を導入してはいけません。 それらは、すでにポータブルで思い出に残るフォーマットに覆われたものを蒸留する必要があります。

深さのための付加的な戦略

ストーリーを伝えよう

人間は物語のために配線されています。問題、解決策への旅、最終結果 - 簡単な物語であなたの説明をラップして、技術的な詳細スティックを作ることができます。例えば、データベースのインデックス作成戦略の機能のリストではなく、チームがインデックスを追加した後に急なアプリケーションの物語を伝えます。救済に対する不満の感情的なアークは、技術的な詳細をアンカーするのに役立ちます。

複数の表現形式を使用する

異なる人々はさまざまな方法で学びます。テキスト、図、言葉、実践的な練習、コードスニペットを組み合わせて、より広い聴衆に達することができます。複雑なトピックでは、短いビデオのデモは、予言のページにはるかに効果的です。単一の文書の中にも、建築図とテキストのアナログが同時に複数の学習スタイルをアドレスするコードブロックを含みます。

貴社の試験を反復し、試験

説明の最初の草案は完璧です。説明を配信した後、自分自身に尋ねてください。聴衆は理解しましたか?彼らは予期しない質問をしましたか?彼らは後で正しい用語を使用していましたか?このフィードバックを使用して、説明を絞り込む。多くの熟練した技術作家やトレーナーは、彼らが現実的な結果に基づいて説明を改良し、改善する個人的な「説明ジャーナル」を維持しています。

フィールドの専門家ではない同僚とあなたの説明を「ピアレビュー」してみてください。 彼らが正確にコアのアイデアをパラファリングできるならば、あなたの説明は固まります。 彼らが苦労している場合は、混乱を引き起こし、それを再作業するセクションをピンポイントします。

コンテンツ

複雑な技術コンセプトを明確かつ簡潔に説明することは、学習と洗練されたスキルです。 視聴者を知ることで、明白な言語とアナログを使用して、情報をチャンクに分割し、視覚的な例を雇用し、やり取りし、重要なポイントを要約することで、コミュニケーションの有効性を劇的に改善することができます。

より深い読書のために、 ]のリソースを検討してください。 ニエルセン・ノーマン・グループ 技術的なライティング]または[]]]]]]の複雑なアイデアを説明するためのハーバード・ビジネス・レビューのアドバイス。 すべての説明は、成功した技術コラボレーションのための2つの重要な成分を、信頼と理解を築く機会であることを覚えておいてください。