seri::diary

日常

あなたのdocumentation力はどこから?

転職して2ヶ月が過ぎた.7社目である.

転職すると毎回色々と発見がある.前職で発見したのは「自分は英語をしゃべる時に別人格になる」とか「リモートワークは得意だと思っていたけど実はそうでもなかった」といった点である.割とどうでもいい.

今回も新しい発見があった.「自分はソフトウェアエンジニアにしては文章を書くことに抵抗が薄いタイプである」という発見である.
当然,技術書を書くようなレベルの人たちと比べれば遠く及ばないレベルだろうが,どうもticketやPRのdescritpionからDesign docに至るまで,自分は文章を書くことの抵抗が非常に低いということが分かった.

実際,今関わっているprojectの中では一番JIRA ticketのDescriptionが長い自信がある.
全く説明がないものを見つけると自分で分かる範囲で加筆してしまうこともある.Design docも書いたが社内では多分第一号だったらしい.そんな事あるか?俺なんかやっちゃいました?と思ったが,そうなのだそうだ.設計に関するdocumentはもっと増えてほしいので,周囲のSWEにdocuemntation活動を啓蒙し始めたが,これがなかなかうまく行かない.時間がないのもあるだろうが,あまりモチベーションが沸かないようだった.

なぜ自分はdocumentationに抵抗が薄いのだろうか?
多分,文章自体は上手くない.しかし,文章を書いて他人に知識を共有することについてはまぁまぁのスキルがありそうだと自負している.

恐らくはこれまでの経験が関係しているのだろうと思い,過去を振り返ってみる.

前職

前職はバリバリのdocumentation文化だった.
公用語は英語だったがnative speakerはそこまで多くはなく*1,かつ複数タイムゾーンという環境だったこともあり,コミュニケーションの中心は非同期のテキストコミュニケーションだった.

個人差はあったが,SWEはちょっとした小さな機能であってもDesign docをバリバリ書き,JIRA ticketのDescriptionにモリモリ説明を書き,それらのコメント上で非同期に議論を繰り広げていた.また,PRのDescriptionの記述力も非常に重要だった.自分が寝てる間に海の向こうにいる同じチームの同僚にPRをレビューしてもらうためには,十分な量の説明は欠かせないのである.朝起きたらPRが質問コメントだらけだった,では仕事が進まないため,テキストだけで正確に意図を伝えられるかどうかは結構死活問題だった.

SWEだけではなく,product managerも「ちょっとしたshort paperかな」ってぐらいの量の文章を頻繁に書いていた.自分が入社した時は大量のdocumentがあったのでそれらを読むだけで開発に必要な知識のinputが出来てしまうほどだった.当然そういう環境ならば自分もdocumentを書かねばならぬし,なにせ英語を喋った経験がほとんどなかったのでdocumentationでコミュニケーションを図る他になかった.だから,この会社にいた頃に長文を書いて相手に伝える能力はかなり伸びたと思う.

しかし,Design docを書いたのは前職が初めてではない.

前前職

その前の会社でも,日本語だがDesign docに類するdocumentは頻繁に書いていた.タスク管理はGitHubのissueでやっていたがdesciriptionもまぁまぁ書いていた方だと思う.非同期処理をよく書いていたので,自然言語の文章よりはシーケンス図をよく使っていた.

前前前職

その前の会社はフルリモートで受託開発をしていたが,長く常駐していた会社が社内ナレッジの共有とその手段としてのdocumentationを大事にする文化だったので,SES的なポジションだった自分もDesign docは書いていたと思う.

前前前前職

その前の会社ではDesign docに類するような長文はほとんど書かなかった.しかし,当時redmineで管理していたチケットの文章についてはそれなりに気を遣っていたようだ.当時の経験を元に書いた,チケットの書き方に関するエントリがある.

serihiro.hatenablog.com

これを書いたのはもう7年前になるが,結構面白いことを書いている(自画自賛).
何の目的で作られたのか分からないチケット 意味がわからないチケット 後になって振り返ると全然分からないチケット たちと格闘していたようだ.まだ20代の若者だった筆者青年は,これらのチケットと格闘する日々の中で社内におけるテキストコミュニケーションの重要性に気づいたのかも知れない.

恐らくは当時の経験が原点だろう.その前とその前はビジネスメールぐらいで,知識共有のためのdocumentationはしていなかったと思う.まだ大学院にも行っていなかった時期なので論文も書いていなかった頃である.

当時のチケット達の格闘がなければ,今の文章を書く習慣は身につかなかったかも知れないと思うと,まぁなんであれ苦労はしておくものだと,30代も折り返しとなったおっさん臭いことを思う.

ただ一方で,SWEとしてはいくら文章を書いて社内の情報共有に努めた所で大して評価はされないという問題がある.なので,やっぱコスパは良くないスキルなんだよなぁと思う.ただ,まだ顔も知らぬ未来の同僚が,自分が書いた文章で必要な情報をinputすることに貢献できたら嬉しいのが本音なので,これからも必要があればdocumentationに時間をつぎ込んでしまうんだろうなぁと思う.

*1:といっても,普通に英語ができる人ばかりで自分の英語スキルは相対的にクソザコナメクジ以下だった