2020-08-17

「誰がどう見てもそうとしか受け取れない文書術2020版」に参加

先週の金曜日に「誰がどう見てもそうとしか受け取れない文書術2020版」をオンラインで聞いてきた。

【再演4版!!】誰がどう見てもそうとしか受け取れない文書術2020版 - 株式会社サービシンク | Doorkeeper
https://servithink.doorkeeper....

最近コミュニケーションがうまくできてない気がするなー、と。

伝える側が気をつける

名村さんが話されてた通り、伝わっていないのは伝える側の問題であり、解決するにしても伝える側が変えていくしかないところだろう。

そもそもとして自分の怠惰が原因なんだろうから、楽をしようとせず前提の共有や、行間・空気を読まなくても理解できるようにしておかないとだなー。
(前提共有はどこまで書くべきか?とかはあるが。)

ドキュメント自体の探しやすさ

情報をまとめておくとかドキュメント自体のわかりやすさもそうだし、ドキュメントがどこにあるか?とかもわかりやすくしておく必要がありそう。

インデックス、目次的なものをどこまで、どういう基準で置いておくべきか?というのは考える必要があるけれども、大枠くらいは何かあった方がいいんだろうなー。
エンジニアが探したい内容といっても、フロントエンドなのかCMSのテンプレートを作るときなのかで変わってくるだろうし。

ドキュメントはあるけど探せないとか、どこを探すかアタリがつかなくて探せないってのは確かにある話。
タグとかでの分類が万能だとは思わないが、ディレクトリ型は結局そのディレクトリ構成を理解していないことには使いこなせないような気もする。
難しいところなきはする。
とりあえずはできるだけ場所を集約するところから。

検索性とオレオレ用語

検索性という話の中で、単語を日本語(カタカナ表記)にするか、ローマ字表記にするか?によっても、その後の検索性が変わってくるから、気づいたときに書き直している、といっていた。
言われてみれば確かにそうだけど。。。
そこまでやったことはなかったのでこれは気づいたらやっていければなぁ。。。

用語というか、言葉が意味していることがずれているとそもそも話がかみ合わないので、用語集的なものを作ったりすることはある。
見積とかの段階でここを揃えておかないと話の前提がずれることがあるって言うのもあるけど。

あとは実際に制作に入った時も俺俺用語をつかわれると何の話をしているのかが聞く側が考えることになるので、ここは各自が気をつけないといけないよなー。

「XXX」というのを開発するとして、それはざっくりいうと「NEWS」みたいな話ですよね?と「XXX」ではなく「NEWS」みたいなぱっとみわかりやすい単語が一人歩きし始めると開発中も話が通じなくなるし、ドキュメントも意味不明なものになったりするので、注意が必要。

一般的な「NEWS」をイメージとしてもっているのは理解するには役立つかもしれないが、それはあくまで個人的な問題であって、それとは別の言葉がある以上はコミュニケーションの中では勝手に置き換えない方が話はスムーズに進みそう。

これ自体はドキュメントでどうこうというより、そういう使い方をしないようにチーム内で意識していかないとできなさそうなことなので気をつけたい。

タスク管理ツールとチャットツールの使い分け

Backlog に書いて Slack なりのチャットツールで連絡する。
Slack で会話しない、みたいな話。

ここは難しいところだとは思うし、メール通知でいい人もいそうだし悩ましいけど。
急ぎかどうか、とか。

結論としてはBacklog をみれば経緯の全てが確認できるようになっていればいいわけなので、 Slack なり Zoom なりで話したことは必ず転記するということで解決はできそう。

その転記するルールを使う方がいいのか、そもそも Slack とかで議論しないルールを使う方がいいのか?はチーム次第なところはありそう。

タスクの管理ツールとチャットツールをそういう風に使い分ける場合がある、というのは気づきだった。


質を上げていくためには、ドキュメントの質も上げないことには何も始まらないし。
定期的に振り返りながら気をつけていくようにしよう。

伝わる文書は、書いて伝わらず聞き返されて、いかに自分の文書が伝わっていないかを理解して、書き直しを繰り返して身につけていくしかなさそう。

文書自体の伝わりやすさもそれで向上して、そこからチームの理解なり認識が同じ方向にむきやすくなっていくのかなー。

セミナーありがとうございましたm(__)m