Gaiax Engineers' Blog

Gaiaxのエンジニアブログです。 社内の様子をありのままに発信していきます。

情報共有フォーマットの話

こんにちは、Gaiax技術推進室の @ichigotake です。この記事は Gaiaxアドベントカレンダー の22日目の記事です。

情報発信はあまり得意ではないのですが、その中で情報共有をする際に意識している事を紹介します。

はじめに

Qiita:Team等の情報発信ツールやチャットなので情報発信側の手間を減らしつつ受信側に広く伝えるにはどうしたらよいか、という事を日々考えながら社内へ情報共有をしています。

例えば、モバイルプラットフォームは Google I/OWWDC といった大きなカンファレンスでの大きなニュースの発表機会が定期的にあり、最新情報は知っているが少し前の事は知らない(逆もまた然り)、といった事もよくあります。

そんな中で現状を伝えつつ、どうキーワードを共有していくかを意識して実践していく事が重要だと考えます。

まだ適切に実践しきれていない事もありますが、特定の業界についての技術や情勢を知らない人が多い環境では、少ない手間で広く深くリーチ出来る手法を模索していく事が大事だと思っています。

意識していること

本文中のキーワードにリンクを織り交ぜる

脚注の代わりにキーワードをリンクとする手法です。

例えば特定のツールをQiita:Teamでネタを共有したいと思った時、前提知識を説明するのは一手間かかってしまいますし、本質でないものへの説明によって冗長的に見えてしまう事もあります。

さわりだけを掴みたい人はテキストを読むだけで十分、詳しく知りたい人はリンクから新出キーワードを把握して理解を深める道筋を作る事にも繋がる文章となり、一つの文章で様々な人にリーチ可能なアウトプットになる事が期待できます。

リンクを踏まなくても最低限の意図が伝わるような文章を意識するとベターです。

Advent Calendar向けに書かれた各記事の冒頭の挨拶やGaiaxアドベントカレンダー の7日目の @xtetsuji さんの記事Qiita Blogでも使われている手法ですね。

誤解を生む表現がなく適切な粒度で書かれている記事が外部にある場合、自分で書き下ろすコストを払うよりも少ない手間で情報共有が出来て便利です。

感想をチャットへ流す

特定の分野へ従事している人にとって興味深いニュースではあるが、改まって社内全体へアナウンスする程でもないニュースをキャッチした際、こんな流れもあるんだよという事を共有しておきたい時に実践する事がある手法です。

独り言でも特定の誰かへの語りかけでもなんでもいいと思いますが、記事にリアクションを含めて流す事で「あ、今そういう情勢なんだ」という空気感や意見を大雑把に共有する事が出来、さらにそこから別の話題に発展する事もあります。

直近の例で言うと、最近発表されたAndroidStudio 2.0 PreviewのInstant Runという機能について独り言をポストしたところから、iOSアプリのビルドを速めるためにはどうしたら良いのかという疑問が他の方から上がり、現状どんな選択肢があるのか調べてみる流れが生まれました。

社内勉強会や日常会話などで緩いネタを共有する

趣味でアプリ開発をする人が増えるような空気を作ろう、という事ではなく、そのくらいのスコープで話した方が、エコシステムがどの程度整ってきているのかを共有するのに程よいケースもあるかなと感じています。

スコープを補足しながら意見を述べる

「特定のケースではこの通りですが〜」「趣味においては〜」等の枕詞をつける事で、ニュースやSNSなどで見かける情報について、多面的な見方を補助する事に繋がると考えています。

情報を鵜呑みにして誤解されてしまったり、思考が凝り固まってしまったりするようなネガティブな事案を避ける手助けになるのではと思い、意識しています。

過去との比較を織り交ぜる

モバイルプラットフォームの開発環境や実装パターンのトレンドなどの状況は、公式非公式問わず目まぐるしく変わっていきます。

新しい情報を共有する際は、以前から変わった点がある事をほのめかす表現を入れておくと、詳しく知らない人でも便利さを実感しやすくて良いかもしれません。

  • 例) 「AndroidStudio 2.0のInstant Runで水を飲む猶予もなくなった」(社内Qiita:Teamの機能紹介記事の感想から)
  • 例) 「今時のAndroidアプリ開発では定数クラスは殆ど不要になっている」(社内Qiita:Teamの記事タイトルから)

スクリーンショットやサンプルを利用する

百聞か一見に如かず、シンプルなものであれば、テキストによる説明を可能な限り省く事によって、説明不要で単純明快なものである事を体現するのも効果的かもしれません。

会話を整理する

チャットは良くも悪くも気軽に発言が出来るデザインになっている事が多いため、ノイズの多いログから有益な情報を掘り起こすのも大変な事があります。

興味のある話題が出てきた際に発言をまとめて補足をつけると、さらなる理解を深める機会を創出できます。

情報発信をしなくとも、自分専用のメモとして残しておくだけでも後々になって役に立つ事もあるので便利ですね。

発信しようと意識する事によって、重箱の隅を突くような点を調べる機会になったり、Qiita:Team等の別の形で共有する事によって別の方から指摘があったりと、チャット以外での繋がりも大きくなっていく事もあります。

お世話になっているドキュメントのフォーマットを真似る

お手本となる構成をいくつか持っておくと、見出しの構成を考える手間を省きつつ要約しやすくて便利です。

自分は、Perlのドキュメントによくある「SYNOPSIS」や「DESCRIPTION」といった見出しの構成を真似る事が多いです。

「SYNOPSIS」といった文化特有の言い回しを別の単語へ置き換えて構成を真似るだけでも伝わりやすい構成になる印象があり、少ない手間で情報共有をしたい時のフォーマットとして便利です。

Perlのドキュメントでよくある以下の構成は読み書き共に扱いやすいフォーマットだと思っているので、迷ったらこれに従うくらいの気持ちで愛用しています。

  1. NAMEで名前と一文によって一言で概要を伝える
  2. SYNOPSISでサンプルを示す
  3. DESCRIPTIONで詳細な説明をする
  4. 末尾のLICENSEやAUTHOR、その他項目で補足する

Perlモジュールの例: SQL::Maker - Yet another SQL builder - metacpan.org

おわりに

どれも当たり前の事だったり、他にも様々な情報発信をするテクニックがあったりすると思いますが、ざっと思い浮かんだものを挙げました。

使い所を間違えると、冗長的に見えてしまったりノイズになったりする事もあるので、手法を適切に使う事が肝要です。

意識はしていても実践出来ていない事もまだまだ多いですが、少ない手間で効果の高い情報発信をしてノウハウを蓄積させていきたいですね。

明日の Gaiaxアドベントカレンダー は、 @frecce さんによるエンジニア採用に関する記事が予定されているようです!