効果的なコミュニケーションの基本原則のいくつかを活用することで、ブランドと一貫性のある、情報量の多いプロジェクト文書を作成することができます。
また別のオープンソースプロジェクトのドキュメントを実際に書き始める前に、あるいは専門家にインタビューする前に、新しいドキュメントに関するいくつかの高度な質問に答えるのがベストです。
コミュニケーション理論家として有名なハロルド・ラスウェルは、1948年の論文「コミュニケーション理論家の役割」の中でこう書いています：
コミュニケーション行動を説明する便利な方法は、次の質問に答えることです：
- 誰が
- 何を言うか
- どのチャンネルで
- 関係各位
- 効果は？
テクニカルコミュニケーターとして、ラスウェルの理論を応用し、文書に関する同様の質問に答えることで、メッセージをよりよく伝え、望ましい効果を達成することができます。
誰が：ドキュメントの所有者は誰か？
あるいは、その文書の背後にある会社は何なのか？どのようなブランドイメージを読者に伝えようとしているのか？この質問に対する答えは、文章のスタイルに大きく影響します。その会社独自のスタイルガイドがあるかもしれませんし、少なくとも正式なミッション・ステートメントがあるかもしれません。
もし、その会社がまだスタートしたばかりの会社であれば、その文書のオーナーに上記のような質問をすることができます。書き手として重要なのは、あなたが会社のために作り上げた声やキャラクターを、あなた自身の世界観や信念と組み合わせることです。そうすることで、会社の専門用語ではなく、より自然な文章になります。
ファイルタイプは何ですか？
どのチャンネルで：ドキュメントのフォーマットは何ですか？
技術文書の場合、通常、コミュニケーションの経路によって、PDF、HTML、テキストファイルなど、文書の最終的な形式が決まります。また、どのようなツールを使ってドキュメントを書くべきかも決定されるでしょう。
誰に：誰をターゲットにしていますか？
誰がこの文書を読むのか？彼らの知識レベルは？彼らの仕事の責任と主な課題は何か？これらの質問から、何をカバーすべきか、詳細をカバーすべきか、特定の用語を使うべきか、などを判断することができます。場合によっては、これらの質問に対する答えが、使用する構文の複雑さに影響することもあります。
その文書の目的は何ですか？
ここでは、この文書が潜在的な読者のためにどのような問題を解決するのか、あるいは読者のためにどのような質問に答えるべきなのかを定義する必要があります。例えば、この文書の目的は、顧客に製品の使い方を教えることかもしれません。
この段階でもう一つ尋ねるとよいのは、この文書はどのようなビジネス上の問題を解決しようとしているのかということです。ビジネス上の問題を念頭に置くことで、あなたの文章に重要な角度が見えてくるかもしれません。
まとめ
上記の質問は、効果的なコミュニケーションの基礎を形成し、文書が網羅すべきすべてを網羅していることを確認するためのものです。自分なりの質問リストに分解し、作成する文書があるときのために手元に置いておくとよいでしょう。このリストは、書きようがない白紙のページに直面したときにも役に立つかもしれません。インスピレーションを与え、アイデアを生み出す手助けになることを願っています。
