サイト案内

運営してるひと: @sters9

妻と娘と猫と横浜あたりに住んでいます。最近は Go や Kubernetes や GCP をしていますがもっといろいろやりたい!

サイト案内

開発環境の紹介

プライバシーポリシー

tools.gomiba.co

サイト内検索

アーカイブ

2023/01 (1)

2022/12 (1) 2022/11 (4) 2022/10 (3) 2022/09 (2) 2022/08 (4) 2022/07 (5) 2022/06 (4) 2022/05 (9) 2022/04 (8) 2022/03 (10) 2022/02 (21) 2022/01 (8)

2021/12 (11) 2021/11 (1) 2021/10 (4) 2021/09 (2) 2021/08 (1) 2021/07 (2) 2021/06 (5) 2021/05 (10) 2021/04 (1) 2021/03 (8) 2021/02 (12) 2021/01 (8)

2020/05 (2) 2020/04 (2) 2020/02 (2) 2020/01 (1)

2019/12 (3) 2019/11 (2) 2019/10 (5) 2019/09 (3) 2019/07 (6) 2019/06 (4) 2019/04 (3) 2019/01 (2)

2018/12 (6) 2018/10 (4) 2018/09 (6) 2018/08 (7) 2018/07 (16) 2018/06 (7) 2018/05 (7) 2018/04 (5) 2018/03 (3) 2018/02 (10) 2018/01 (6)

2017/12 (8) 2017/11 (6) 2017/10 (10) 2017/09 (12) 2017/08 (12) 2017/07 (3) 2017/06 (1) 2017/01 (4)

2016/12 (5) 2016/10 (3) 2016/09 (1) 2016/07 (2) 2016/06 (1) 2016/04 (1) 2016/02 (1) 2016/01 (2)

2015/12 (1) 2015/10 (1) 2015/09 (3) 2015/06 (1) 2015/01 (1)

2014/08 (2) 2014/07 (3) 2014/05 (1) 2014/01 (7)

2013/12 (2) 2013/11 (4) 2013/10 (1) 2013/09 (1) 2013/08 (3) 2013/07 (4) 2013/06 (5) 2013/05 (2) 2013/04 (7) 2013/03 (1)

ドキュメントを育てていく

(ドキュメント=自分たちのためのドキュメント、という体)

ドキュメントを用意する、というのは一定面倒なタスクではあるけれど、なぜ面倒なのかを考えてみると、こんなところがあるんじゃないだろうか。

  • 全部を書かなくちゃいけない
  • ぶっちゃけ仕様がわからない
  • どこまで書いたらいいかわからない
  • どういう構造が適切かわからない
  • コードがドキュメント
  • 図を作るのが面倒
  • 陳腐化する(更新が必要)

究極、自分たちの頭の中に全部あって、全部共有されていて、という状態であればドキュメントなんてなくていいだろうけれど、まあなかなかそうはいかない。現実には、あれなんだっけ、これなんだっけ、人が来たので説明しなくちゃ、などなど色々ある。そうするとドキュメントがあると何かと便利なので用意したくなる。

そして、ドキュメントを用意しようというときに、最初から超完璧なものを用意できればそれが一番いいけれど、そんなことをしていると時間がかかる。なので、小さくリリースを繰り返して育てていく、というのがいいのではないだろうか。

PRでは一つの大きなものでドドン!とするとレビューに時間もかかるしリリース時の大変さも増える。たとえば、ペアプロでPRの大半を作ってレビュー時間を削減したり、機能はあるけど有効にはなっていない状態、とかできると大きなPRでも問題は少ないかもしれないけれど…。なので、小さいPR、小さいリリースを頻度を上げて繰り返すことでリードタイムや負荷を減らすのがいいと思っている。

これと同じ話をドキュメントでも言える。ドキュメントも一度にドドン!ではなく、小さくリリースを積み重ねたい。

さらに、プロダクト開発はコードを書いて機能を増やしたり減らしたり、コードの構造を変えて開発しやすくしたりをするけれど、これとドキュメントもまったく同じだろう。ドキュメントそれ自体もプロダクトとして捉えたほうがいいかも。

プロダクト = ドキュメント(自分たちのドキュメント)、であれば、ユーザ = 同じチームの人たち、になる。他にも…

  • 新機能の開発 = 新規ドキュメントの執筆
  • 機能の改善 = ドキュメントの加筆/修正
  • 機能のリリース = ドキュメントの公開
  • 機能の削減 = ドキュメントの廃止
  • 機能提供のためのコードをリファクタリング = ドキュメント構造・内容の見直し
  • 他プロダクトとの連携 = ドキュメントのリンク、引用
  • 悪いUX = 自分たちがドキュメントを活用できていない

などなど…。他にもプロダクト開発でこういうことしてるよな、というのは全部当てはめられるはず。

そう考えてみると、自分たちが使う自分たちのためのプロダクト=ドキュメントを育てるのは、プロダクトの価値を向上させるためにコードを書いてプロダクトを育てている、と同様だし、育てるのをやめてしまえば、ユーザが離れていってしまう=自分たちがドキュメントを使わなくなる、というのも理解しやすい。

小さく更新を積み重ねていくのであれば大変さも少ないので、やりやすいのではないだろうか。


とはいえ、やっぱり面倒な部分はある(もっと要素を分解できる)ので、それぞれ現実的にどうするかはまた別の話…