文書作成における個人的訓戒


この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので十分ご注意ください。

こんにちは、きおかです。

これが正解ってわけではないと強く思いますが、現状私が運用保守フェーズにて文書に関して感じたこと・学んだことを残しておこうと思います。

そのうちドキュメント作成・管理や品質管理の本を読んで、ブラッシュアップさせていきたいなと朧げに思っています。

伝達の歴史

昔の人々は教訓や自戒、歴史を忘れまいと、それらを歌にのせて伝承しました。
本当に大事なものは紙に書くことで、情報の寿命を伸ばしました。

近代的な印刷技術が発明されると、大量の聖書を印刷して同じ考えを持つ人を増やし、組織化していきました。

軍事技術に由来するコンピュータが民主化され、大量の情報がコンピュータを介してやり取りされ、また、コンピュータに保存されるようになりました。

情報は人間の寿命を超越し、人間は記録媒体を介して過去を大きく遡ることができるようになりました。

現在はChatGPTなどのAGIが発達したことで、人間はもはや歴史と対話することができるようになりました。

文書の役割

文書とはいついかなる時代においても、過去の半永続的な記録媒体として、また、共通言語の確立手段として活躍してきました。これは現代でも変わらず存在する、文書における普遍的な本質だと信じています。(もちろん小説や詩など、必ずしも上記のような性質を持ち合わせない文書もあります。この記事では、他者と協力して目的を達成したり課題を解決して利益を生むというビジネス活動における文書を指します。)

文書があることで、他者とのコミュニケーションの時間を減らすことができます。これはコミュニケーションをしないことが是という話ではなく、より価値のある話題に集中することができるようになり、コミュニケーションの価値が上がるということです。

逆説的に言えば、文書はコミュニケーションコストを下げるためにあるべきです。文書を読んだのに余計にわからなくなって他者に聞いたりするのでは、文書の意味がありません。むしろ現場を混乱させるわけだから、その文書は早めに改修するか、最悪一時的に使わないようにした方がよいかもしれません。

ハイコンテクスト言語である日本語

特に日本語には、文脈や行間が間接的に意味を表すという言外の(すなわち無意識に近い)意味補完機能や、助詞という柔軟な文法機能があります。しかしこれは不完全な機能であり、中々取り扱いが難しいものです。特に5W1Hを付加する際にはなかなか難しい。

日本語は、英語のように決まった場所に主語・動詞や動詞の対象になる語、時間を表す表現が来るわけではありません。5W1Hが必要十分にそろった文を作るのだって、日本語でやろうと思うと違和感がある文ができやすく、違和感がないように5W1Hの情報の順番を変えたりする必要があります。もちろん英語でも同様ですが、日本語ほど必要はない印象です。

日本語は文脈に頼る傾向にあり、明示的に意味を表すことを意識する必要があると思います。(ただ日本語は大学の高等数学を記述できる言語ですし、個人の言語経験による部分が多いとは思いますが。)特に手順書においては、組織(チームや部などの単位は何でもいいです)内に求められている最低限の知識以上のことを期待せず書くのがよいと個人的に思っています。その分文書は長くなりますが、文書を利用する人が増えれば増えるほどコミュニケーションコストは比例して下がるので、問題ないでしょう。また、どの程度細かく書くのかについては、その文書がどの程度のコミュニケーションコスト低下を目指すのかによって変わると思います。

文書を作成・運用・保守する上で気を付けること(試行錯誤中です。。)

  1. 文書の整備やフォルダ構成は品質管理の一環であるが、必ずしもトップダウンの業務ではない。現場レベルでしか使われていない文書で、かつその文書が余計な作業や意図しない作業を生んでいるなら、文書を整備すべき。
  2. 別の文書が関係する場合、その文書の所在や関係を明示する。ファイルのパスをリンクにして貼り付けたり、別のシートへリンクで直接飛べるようにする。説明を付加してもよいし、スペースがなければ※で注釈をつけてもいい。
  3. 文書のタイトルや目次、グループ分けをするようなものには、その役割や他との関係が推測できるような名前をつける。抽象と具体の行き来が適切に行える/行いやすい名前にする。
  4. 更新したい/更新した部分は認識合わせの機会を設ける。更新箇所が本当にコミュニケーションコストを減らすことに貢献するのかを自分以外の人に確認してもらう。認識合わせのコミュニケーションは次なる文書作成への良きインプットとなる。

さいごに

なんとなーくですが、開発で言われてる読みやすいコードを書けっていうのはこういうことに関連するのかなぁと思ったりしました。

なんにせよ、コミュニケーションはできるだけスムーズでクリエイティブな活動であってほしいと個人的に思うので、仕事で扱う言葉には気を付けたいと思います!

今回はここまで!

Last modified: 2023-11-24

Author