日本UNIXユーザ会「夏のドキュメンテーション祭り」を開催しました

2019年8月24日（土）に日本工学院専門学校・蒲田キャンパスで、日本UNIXユーザ会(以下jus)主催で「夏のドキュメンテーション祭り」を行いました。オープンデベロッパーズカンファレンス(ODC)2019の中での開催です。スライド資料や動画を共有し、簡単なレポートをします。

猛暑だった夏もやや涼しくなってきつつある中、多くの人が集まりました。セッションによっては満員で空気が薄く感じました。

ドキュメンテーションについて議論するため、藤原さんと私は関西で「ドキュメンテーションの集い」という勉強会をしています。今回、東京でもイベントをやってみようということで２人で企画しました。人や資金面でのサポートが得られるということで、主催は私が幹事をしているjusにしました。「エンジニアが実践的なドキュメンテーションをどう作るか」というテーマで3つのトークとパネルディスカッションを行いました。

企画の方向性や広報、さらにはスピーカー1人目として藤原さん、事務方としてお金の処理などはjusの岡松さん、ビデオ撮影やパネルの時のフォローはjusの松澤さん、写真撮影はjusの小山さん、私は企画、ODCやスピーカーとの交渉などを担当しました。どのセッションも、ドキュメンテーションについて考えさせられるお話でした。

「専門学校教育におけるドキュメンテーションの役割」藤原由来 (神戸電子専門学校 / ソラソルファ)

藤原さんはPandocのドキュメントを翻訳したり、Markdownの本を書いてる人ですが、セミナーでは専門学校での現場でのドキュメントについてでした。「知識を与える/魚を与える」場合は講師が先回りで細かくドキュメントを書く、「自分で知識を得る力を得る/魚の釣り方を与える」場合は学生がドキュメントを書く、と2つにわけてました。学生は文章を書くことになれてないのでテンプレートを使う、などの工夫が印象に残りました。

「まだそんなドキュメントで消耗してるの? 開発効率を上げる攻めのドキュメンテーション」田中 一紀 (株式会社ソニックガーデン 業務ハッカー)

田中さんは「納品しない受託開発」というコンセプトで有名なソニックガーデンで活躍するエンジニアです。登壇は初めてとのことでしたが、堂々とされていてとてもそうは思えない感じでした。アジャイル開発でかつリモートワークされているなかでどのようなドキュメントを作られているか紹介がありました。本筋ではないですが、仕事しながらオーストラリア3ヶ月車で一周まわったお話にびっくりしました。ドキュメントは作るが仕様書は作らない、ドキュメントはコミュニケーションの手段と言われているのが印象的でした。

「運用ドキュメント 2019 〜手軽にスピーディに継続的に保守するためのドキュメント入門〜」波田野裕一 (運用設計ラボ合同会社)

波田野さんはjusの幹事であり、運用ドキュメントの専門家です。今回はドキュメンテーションの戦略的な側面から、実際にどうやっているかまで盛りだくさんな内容でした。論理力を上げる必要があるというお話が印象的です。運用業務では人は入れ替わっていくので、人のナレッジを前提にしない、ということで全部ドキュメントにすべきということでした。ドキュメントの対象者がアルバイトレベルでは無限の工数がかかるので、対象想定スキルは応用情報技術者くらいがいいのではとのことです。私が見聞きする範囲では、スキル対象は下げすぎてる印象がありましたので、なるほどと思いました。また、平易ではなく属人化した方がよいものもあるとの説明もありました。もう少し暗黙知として人にナレッジを蓄えてもいいのでは？という感想は持ちましたが、入れ替わりが激しく、それでは通用しないことが多いのかもしれません。

パネルディスカッション「開発・運用ドキュメンテーションをどうデザインするか?」

スピーカーの藤原さん、田中さん、波田野さんの3名と私で行いました。あまり打ち合わせはせずに会場からの質問を拾いながら進めました。いろいろ質問いただけて助かりました。「ユーザ企業でインフラ管理しているが、ドキュメントが追いつかない。陳腐化してしまう」という質問に対しては、波田野さんからは「使い捨てと資産部分をわけましょう」とコメントがありました。資産を作っておいて、シェルスクリプトで使い捨て部分は自動生成するようにされているそうです。

とてもよいセッションが揃い、また多くの参加者に恵まれてよかったです。講師の3名の方や手伝ってくださった幹事に感謝します。 jusの活動とは別に、関西での「ドキュメンテーションの集い」は10月ごろに開催できればと調整中です。