Docs Like Code を買った

技術文書に関する本をまた一冊購入しました。

内容を一言で紹介するならば、「技術文書を書くときもソフトウェアを書くときと同様に Git と GitHub を使いましょう」というものです。

Docs Like Code の考え方は次の記事にわかりやすく書かれています。Docs-from-Code というのも参考になりました。

実は、私は 2 年ぐらい前に Git や textlint を使ってドキュメント管理し CI の中で構文チェックを行うようなしくみを構築したことがあったのでいろいろ思うとこことがありました。

ソフトウェア開発者寄りの見方ではソフトウェア開発と同様のワークフローを採用することで開発者を巻き込みやすくなるというメリットを感じました。実際に、何度か開発者から直接プルリクをもらうこともあり、実際にそのメリットを実感できました。

一方で、ライティングの中心となるライターさんが Git を使いこなせずに結局使われなくなるという苦い思いもしました。今思えば Docs Like Code によって得られるメリットがライターさんの立場では小さかったため、自ら Git を学習しようというようにならなかったのだと思います。

今思えばライターさんたちの関心はワークフローの改善ではなくより上流の問題にあったため Docs Like Code によって得られるメリットが小さかったのではなかいと思います。自分自身が得られる恩恵が少なければ、自ら Git を学習しようというようになりませんよね。

このことから、ソフトウェア開発者が中心となるプロダクトでは Docs Like Code の考え方を浸透させる余地はあるのでしょうが、一般向けのプロダクト開発においてはこれだけでは受け入れにくいだろうなと思います。

(なんだか愚痴みたいになってしまいました。)