## 概要

オライリーの「プロダクションレディマイクロサービス」

https://www.oreilly.co.jp/books/9784873118154/

を読んだので、内容やノウハウをメモする。

## 全体感

UberのSREがプロダクションレディなマイクロサービスはどのようなものかについてチェックリスト的にまとめた書籍。

全体としては書籍の体は保っているものの、本当にチェックリストのようだった。

付録には本当にチェックリストという名目で箇条書きで掲載されており、確かにこれが網羅できていればプロダクションレディと言えそう。

一方で、これを全てやるのは至難の業。少なくとも日本国内だとこんなしっかりとしている企業は無いのではないかというレベル。

総じてイデア的に使うものであり、必要十分条件ではないと感じた。

(この書籍の内容が出来ていればプロダクションレディかもしれないが、プロダクションレディなサービスがこの書籍の内容を満たすとは限らない。)

## ノウハウ

本番対応の原則は以下の8つの項目である。

1. 安定性
2. 信頼性
3. スケーラビリティ
4. 耐障害性
5. 大惨事対応
6. パフォーマンス
7. 監視
8. ドキュメント

### 安定性

安定して動く、バグがない、のようなものではない。

CI/CDが整っているか、開発プロセスはわかりやすいか、など開発者目線での安定感が要点。

### 信頼性

テストは十分か、完璧なステージング環境があるか、カナリアリリースが行われているか、など。

### スケーラビリティとパフォーマンス

その名の通り。これらはまとめて語られていた。ボトルネックの明確化やキャパシティプランニングが適切に行われているかなど。

### 耐障害性と大惨事対応

これらもまとめて語られていた。単一障害点が無いこと、起こりうる大惨事が明確になっていること、障害対応手順の標準化など。

### 監視

ロギング、アラーティング、オンコールなどが適切に行われていること。ダッシュボードが整備されていること。

面白かったのは以下。

> オンコールランブックは、半分寝ている開発者でも難なくたどれるように書かれていなければなりません。

Susan J. Fowler. プロダクションレディマイクロサービス (p.233). Kindle 版. 

確かにその通りなのだが、「半分寝ている」という表現がちょっと面白かった。そんなランブックを書くことが果たしてできるのかという疑問は残るものの、やはり理想としては間違いない。

### ドキュメント

> 本番対応のよいドキュメントの目標は、サービスについての知識を一元的に管理するリポジトリを作って、メンテナンスすることです。共有すべき知識は、サービスについてのありのままの事実と、サービスが何を行い、組織全体でどのような位置を占めるかについての組織的な理解の両方です。そのため、ドキュメントが貧弱だという問題は、ドキュメント（事実）の欠如と理解の欠如の2つの下位問題に分けることができます。これら2つの下位問題を解決するには、すべてのマイクロサービスを通じてドキュメントを標準化するとともに、マイクロサービスについての理解を共有するための組織的な構造を用意する必要があります。

Susan J. Fowler. プロダクションレディマイクロサービス (p.224). Kindle 版. 

ドキュメントに関する項目があるのが非常に意外だった。他の項目は当たり前な部分が多いが、この項目に関しては新たな示唆が得られた気がする。

他にも引用しておくと以下のようにも書かれていた。

> 多くの開発者は、リポジトリ内にREADMEファイルを置くかコードにコメントをばらまいておけば、ドキュメントとして十分だと思っています。READMEファイルは必要不可欠であり、すべてのマイクロサービスのコードには適切なコメントが含まれていなければなりませんが、READMEは本番対応のドキュメントではなく、コメントはチェックアウトしてコード中を探し回らなければならなければ役に立ちません。

Susan J. Fowler. プロダクションレディマイクロサービス (p.226). Kindle 版. 

ドキュメントの有無は本当に大きい。「コードを読めばわかる」なんて表現は、個人的には場当たり的にコードを書く能力、時間しかありませんと言っているようなものだと思う。

例えばマイクロサービスとして利用している他チームのAPIを呼ぶ際に適切なタイムアウト値が知りたいとする。そんなとき「コードを読んでください」なんて言えない。API仕様書などの明示できるドキュメントが無ければ、利用者全員に対して個別に回答しなければいけないかもしれない。

全体として大規模なサービスになればなるほどマイクロサービスの利用者も増えるので、大手ほどこの問題が発生する可能性が高いはず。この書籍は全体的にそういう対象について議論しているように見える。

## まとめ

「プロダクションレディマイクロサービス」について感想やノウハウをまとめた。

誰かの参考になれば幸いです。

「プロダクションレディマイクロサービス」を読んだ

## 概要

技術書典16にサークルとして初参加したので、感想やノウハウを備忘録としてまとめる。

https://techbookfest.org/product/t0gGBQLsrkizaw1en9skWJ

## 感想

### 本を作るのは大変

同人活動がそもそも初めてだったのだが、まず「本を作る環境」を作ることが大変だった。TechBoosterのReVIEW-Templateのコードを読み込み、

https://github.com/TechBooster/ReVIEW-Template

それを元に自分が使いやすいように整備した。それについての詳細はZennの記事にまとめた。

https://zenn.dev/miketako3/articles/d6407d5280d298

本のサイズは？余白は？ページの通し番号は？それらを適切に一から整備するのは非常に厳しい。よくわからない人はTechBoosterのReVIEW-Templateを使うのが一番だと思う。

ただし、それでも設定ファイルやReVIEWの仕様を理解する必要があり、ビルド設定やPDFの生成方法等もWebのエンジニアじゃないと馴染みがなくて辛いと思われる。

本文を書くだけである程度綺麗に出来上がるフォーマットが欲しいところ。

そして本文を書くのも当然大変で、自分の場合は目標としていたページ数まで到達しなかった。

初回ということでそこまで無理しないように作ったが、次回はもう少し構成を練ってページ数を増やすようにしたい。

### 本を売るのも大変

まず宣伝をしないといけない。マーケティングの一番最初は認知から始まる。

自分の場合はTwitterを使ってフォロワーを増やし、イベント当日にはそのフォロワーに宣伝を行なった。

また、お品書き画像を作ったり、当日の運用を考えたりと、本を売るためにはかなりの労力が必要だった。

### 得られるものは大きい

それでも、技術書典に参加して得られるものは大きい。

自分は今まで在庫を抱えるような商売をすることはリスクの大きさからなるべく避けてきた。

今回初めて同人活動とはいえそのような経験をして、かなり勉強になったと思う。

そんな大量に儲けが出たわけでは無いが、初めてで赤字ではないだけ御の字というところだろう。

オフラインも終了したら赤裸々に収支を公開したい。

## ノウハウ

### 入稿フォーマットや締め切りをなるべく早めに確認する

同人イベントに参加したことが無い場合、印刷所の入稿フォーマットや締め切り等の情報を特に早めに確認しておくべき。

日光企画においては以下で、表紙テンプレートはここからDLして編集した。

https://www.nikko-pc.com/offset/template/tonbo.html

本文の方は前述のテンプレートから生成すれば問題なかった。

印刷の専門用語が全くわからないばかりか、デザインの知識もないので、非常に時間がかかった。

表紙、本文共に入稿フォーマットは必ず最初に確認しよう。

### PhotoshopやIllustratorが無くてもなんとかなる

自分の場合は互換のAffinity Publisherを使ったが、簡易的な表紙デザインであれば無くてもなんとかなる。

他のデザインソフトでも同様だろう。ただし、最低限psd形式が読み込める方が良い。

とはいえ余裕があるならデザイナーに依頼するのが一番ではある。デザインは難しい。

今回はロゴとかヘッダーとか色々なクリエイティブも一緒に作成した。統一感を持たせるのはかなり大変だった。

![名刺表](/tech-book-fest-16/名刺表.png)
![名刺裏](/tech-book-fest-16/名刺裏.png)
![ロゴ](/tech-book-fest-16/ロゴ.png)

### 宣伝はなんだかんだX (Twitter)

現状最も認知が稼げるプラットフォームはXであるから、それをやらない手はない。

2ヶ月前あたりから意識して、1ヶ月前あたりからはフォロワーを増やす動きを意識的に行なった。

具体的にはツイート頻度を増やしたり、いいねやフォローを行なったり。

個人的にはプロ驚き屋には絶対なりたく無いという思いもありかなり辛かった部分だが、なんとか上手くバランスを取れたと思っている。

また、お品書き画像は必ず作るべき。SNSでの宣伝には欠かせないし、当日ポスター的に飾って宣伝するのにも使える。

https://x.com/miketako3/status/1794545296472711469

### 当日の設営

![設営](/tech-book-fest-16/設営.png)

今回は技術書典の手ぶらセットというものを申し込んだため、以下は用意されていた。

- テーブルクロス
- マッキー
- 決済QRコードが書かれた紙とスタンド
- ポスター的なもの
- マスキングテープ
- 色々なものを立てかけられる簡易スタンド
- デコレーションシール

それ以外にも色々と準備した。

まず何らかの形でお品書きポスターは用意しておくべき。こなれている感はかなり売り上げに関わるんじゃ無いかと思っている。

また、本は見本用に何冊か用意し、透明ブックカバーをつけておくと良い。見本だけ見て買わない人もいるが、そういう人は買っても満足してはくれないので、見てくれただけありがたいと思っておくべき。

あとは名刺を作って本と一緒に配ったり、ぬいぐるみを置いておいたり、モバイルディスプレイで画像をスライドショーしたりしてとにかく目に止まるようにした。

### 現金決済には対応しておくべき……は古いのかもしれない

現地の電波障害や、そもそも公式後払いに対応していない方のために、現金決済は可能な限り対応しておくべき……と思っていた。

私は先人に倣い、パスワード付きのZIPファイルを用意しておき、購入者にパスワードを記した紙を渡すことで対応できるようにした。

https://miketako3.booth.pm/items/5754237

しかし、実際は特に何の問題もなく全員が公式後払いでの決済をしてくれた。

1人だけ現金決済を希望された方がいたが、お願いしたら後払い決済にしてくれた。後払いはキャンペーンもやっていたので非常にありがたかった。

https://blog.techbookfest.org/2024/05/11/tbf16-event-print-order/

もはや現金は対応しなくても良いのかもしれない。

## おわりに

今回は技術書典16にサークルとして初参加して、得られたノウハウをまとめた。

次回はもう少しページ数を増やして、より多くの人に読んでもらえるような本を作りたい。

まだオフライン開催は続くが、オフラインも終了したら赤裸々に収支を公開したい。

この記事が誰かの参考になれば幸いです。

良かったらX ([Twitter](https://x.com/miketako3)) をフォローしてください！

技術書典16にサークルとして参加した

## 概要

オライリーから出ている 「ソフトウェアアーキテクチャ・ハードパーツ」

https://www.oreilly.co.jp/books/9784814400065/

を読んだので、重要な章を抜き出してノウハウをメモする。

と言いたいところだが、重要な部分が多すぎるのでこの記事では書きやすい部分だけを抜き出している。

書籍の内容を拾いきれているとは到底言えないので、是非読んでもらいたい。

ある程度システム設計に明るく、アーキテクチャに課題を抱えている人にはぴったりな内容になっていると感じた。

## 1章 「ベストプラクティス」がないとどうなる？

全ての解決策はトレードオフである。

> アーキテクトは、自分の問題に対する「銀の弾丸」を探し求めてはならない。

アーキテクトの問題はそれぞれユニークなため、ベストプラクティスが存在しない。

だからこそ「ハード」パーツである。

- 難しい問題
- 堅い、システムの土台となる部分

> 決して最善のアーキテクチャを狙ってはいけない。むしろ、少なくとも最悪でないトレードオフの組み合わせを狙おう。

多くのアーキテクチャにおいて、データこそが全てである。

アーキテクチャデシジョンレコード（Architecture Decision Records：ADR）（https://adr.github.io）を記入せよ。

アーキテクチャ統制のため、アーキテクチャ適応度関数を設計、運用せよ。

## 2章 ソフトウェアアーキテクチャにおける結合の見分け方

結合の定義

> 一方の変更が他方の変更を引き起こす可能性がある場合、ソフトウェアシステムの2つの部分は結合している。

結合を発見、分析し、トレードオフを評価せよ。

アーキテクチャ量子の定義

> アーキテクチャ量子とは、高度な機能的凝集、高度な静的結合、同期／非同期による動的結合を持つ、独立してデプロイが可能なアーティファクトを指す。アーキテクチャ量子の一般的な例には、あるワークフロー内の整ったマイクロサービスなどがある。

これはすなわち、データベースを共有しているアプリケーションは全て1つのアーキテクチャ量子である。

## 4章 アーキテクチャの分解

モノリスからサービスベースアーキテクチャを経てマイクロサービスへ移行していく上で、2つのアプローチが紹介されている。

- コンポーネントベース分解
  - まずはリファクタリングし、モジュールを分けていく。
  - 分けられたモジュールをサービスに切り出す。
- 戦術的フォーク
  - まるっと別アプリケーションとしてコピーして立て、それぞれ1部の機能しか使っていない状態にする。
  - その後、不要な機能をリファクタリングによって削除していく。
  - コンポーネントベース分解と比べて
    - メリット
      - 事前の分析が不要なので作業開始が早い
      - コードは抽出するより消す方が簡単 (と書かれていたが本当か？)
    - デメリット
      - 不要なコードを消す努力が必要
      - ロジックは汚いまま

## 6章 業務データの分解

データベースを分けるか？分けないか？もトレードオフである。

データを分解する要因として以下のようなものがある。

- 変更制御
  - カラムの変更等の影響が多岐にわたる
- コネクション管理
  - 1つのデータベースだけを使うとコネクション数の管理が難しい
- スケーラビリティ
  - コネクション数
  - 容量
  - スループット
  - パフォーマンス
- 耐障害性
  - 1つのデータベースだけを使うとデータベースが単一障害点となってしまう
- アーキテクチャ量子
  - 1つのデータベースだけを使うと1つのアーキテクチャ量子となってしまう (つまり独立してデプロイできない、等)
- データベース種別の最適化
  - 1つのデータベースだけを使うと1つの保存方法だけしか使えない (つまりデータ特性ごとに最適な選択肢が取れない)

逆に、データを統合する要因としては以下のようなものがある。

- データ関係
  - 密結合な外部キー等があるか？
- トランザクション
  - 単一のトランザクション単位が必要か？

モノリスなデータベースを分解するには5段階のプロセスを踏むと良い。

1. 分析し、ドメインを特定する
2. ドメインごとにテーブルを割り当て、移動する
3. コネクションをドメインごとに分離する
4. スキーマをそれぞれのデータベースに移動する
5. コネクションを切り替える

## 7章 サービスの粒度

マイクロサービスの粒度を大きくするか？小さくするか？もトレードオフである。

粒度を小さくする要因としては以下のようなものがある。

- サービスの範囲と機能
  - 凝集性が高い状態になっているか？
- コード変動率
  - 一部のコードだけ変更頻度が高くないか？
- スケーラビリティとスループット
  - 一部だけスケールする必要があるか？
- 耐障害性
  - 一部の故障で全体が故障してしまわないか？
- セキュリティ
  - 一部だけ高いセキュリティが必要か？
- 拡張性
  - どの程度拡張されるか？

粒度を大きくする要因としては以下のようなものがある。

- トランザクション
  - サービスをまたいだトランザクションが必要か？
- ワークフローとコレオグラフィ
  - サービス同士がやりとりする必要はあるか？
- 共有コード
  - サービス同士がコード共有の必要はあるか？
- データ関係
  - データは分解できるか？

## 9章 データの所有権と分散トランザクション

サービス間で共有するデータが存在するとき、どちらのサービスが所有権を持つのか、どのように共有データを管理するのかをトレードオフによって決めなければならない。

分散トランザクションはACID特性をサポートしないため、代わりに結果整合性を検討せよ。

## 10章 分散データアクセス

所有していないデータにサービスが読み取りアクセスするためには様々な方法があり、その間にもトレードオフがある。

- サービス間通信パターン
  - サービス間がWEB API等で通信してDBを隠蔽する
- 列スキーマレプリケーションパターン
  - 非正規化する
- レプリケーションキャッシュパターン
  - 分散キャッシュする
- データドメインパターン
  - 愚直に一緒にDBを見てしまう

## 11章 分散ワークフローの管理

分散システムどうしを調整する方法については基本的には2種類あり、トレードオフがある。

- オーケストレーション
  - 調整役を別途立てる
- コレオグラフィ
  - 最初のサービスが調整役となる

## 12章 トランザクショナルサーガ

通信、整合性、調整についてそれぞれ2パターンあり、組み合わせると合計8パターンのサーガ (アーキテクチャの大別) がある。

| パターン名       | 通信  | 整合性   | 調整         | 結合度   | 複雑さ   | 応答性/可用性 | スケーラビリティ |
|-------------|-----|-------|------------|-------|-------|---------|----------|
| エピックサーガ     | 同期  | アトミック | オーケストレーション | とても高い | 低い    | 低い      | とても低い    |
| 伝言ゲームサーガ    | 同期  | アトミック | コレオグラフィ    | 高い    | 高い    | 低い      | 低い       |
| おとぎ話サーガ     | 同期  | 結果整合性 | オーケストレーション | 高い    | とても低い | 中程度     | 高い       |
| 時間旅行サーガ     | 同期  | 結果整合性 | コレオグラフィ    | 中程度   | 低い    | 中程度     | 低い       |
| ファンタジーサーガ   | 非同期 | アトミック | オーケストレーション | 高い    | 高い    | 低い      | 低い       |
| ホラーストーリーサーガ | 非同期 | アトミック | コレオグラフィ    | 中程度   | とても高い | 低い      | 中程度      |
| パラレルサーガ     | 非同期 | 結果整合性 | オーケストレーション | 低い    | 低い    | 高い      | 高い       |
| アンソロジーサーガ   | 非同期 | 結果整合性 | コレオグラフィ    | とても低い | 高い    | 高い      | とても高い    |

## 13章 コントラクト

ハードパーツとしてのコントラクトの定義は以下である。

> アーキテクチャの部品が情報や依存関係を伝えるために使用するフォーマット。

コントラクトとして例えば以下の様なものがあり、トレードオフがある。

- 堅い
  - 例
    - gRPC
  - メリット
    - 型
    - バージョニング
    - 検証が用意
    - ドキュメント
  - デメリット
    - 密結合
- 緩い
  - 例
    - JSON
  - メリット
    - 疎結合
    - 進化しやすさ
  - デメリット
    - 型がない
    - コンシューマ駆動契約等の適応度関数が必要

帯域幅は無限だと思うな。

## 15章 独自のトレードオフ分析を構築する

MECEに分析せよ。

技術の過度な売り込みを避けよ。

> 何かを伝道する立場をとってはいけない。トレードオフに立ち返ろう。

> 銀の弾丸を追い求めるのではなく、トレードオフを分析するスキルに磨きをかけることで、アーキテクトは組織に真の価値を提供できるのだ。

## まとめ

アーキテクトというふわっとした分野において地に足ついた良い本だった様に感じた。

全てはトレードオフである、というのは自分も読む前から感じていたことではあったため、裏付けが取れて嬉しい気持ちになった。

そして、そのトレードオフをこれでもかと投げつけてくる本書は実際にアーキテクチャを考える上で非常に参考になるだろう。

最近「マイクロサービスって間違いだったんじゃね？」等が話題になったりもしたが、そういうことに振り回されず淡々とトレードオフを分析できるエンジニアになりたい。

「ソフトウェアアーキテクチャ・ハードパーツ」を読んだ

## 概要

「ソフトウェア見積もり 人月の暗黙知を解き明かす」

https://www.amazon.co.jp/%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2%E8%A6%8B%E7%A9%8D%E3%82%8A-%E4%BA%BA%E6%9C%88%E3%81%AE%E6%9A%97%E9%BB%99%E7%9F%A5%E3%82%92%E8%A7%A3%E3%81%8D%E6%98%8E%E3%81%8B%E3%81%99-%E3%82%B9%E3%83%86%E3%82%A3%E3%83%BC%E3%83%96-%E3%83%9E%E3%82%B3%E3%83%8D%E3%83%AB-ebook/dp/B00KR96M6K

を半分程度読んだのでノウハウについて章ごとにメモする。

残り半分を読んだ段階で記事を更新する予定。

## 第1部 見積もりの考え方
### 第1章 見積もりとは

- 「見積もり」「ターゲット」「コミットメント」の違いを意識する
  - 見積もり：そのままの意味
    - 「この機能の実装は何人日」
  - ターゲット：実現したいビジネス上の目標
    - 「何日までにこの機能を提供したい」
  - コミットメント：機能を一定のレベルで期日までに納品するという約束
    - 「何日までにこの機能を提供します」
- 見積もりと計画の違いを意識する
  - 見積もりは正確性が重要
  - 計画は結果が重要
  - 偉い人にターゲットを達成するための計画を聞かれているのに見積もりを単に答えてはいけない
    - 「このプロジェクトは何人月？期限は３ヶ月なんだ」
    - 「見積もってみたところ５ヶ月かかります」
    - 「ふざけるな！」
  - 開発と期日どちらが優先かどうか尋ねる
- 良い見積もりとは偉い人の意思決定に寄与する見積もりのこと

### 第2章 見積もり能力のチェック

- 直感で「90％確か」な見積もりは、実際には「30%確か」
  - なので直感で90%とか言ってはいけない
- 見積もりなんて幅があって当然。無理に狭めようとしない

### 第3章 正確な見積もりの価値

- 意図的に過小に見積もることはすべきではない
  - 過大見積もりよりも深刻な被害が起きる
  - では過大にすれば良いかというとそうでもなく、それなりに大きくしてあとは計画とコントロールで対処せよ

### 第4章 見積もり誤差はなぜ起きる？

- 見積もり期間を増やしても見積もりの不確実性は上がらない
  - プロジェクト自体があやふやなのではどんなに頑張っても上がらない
  - 見積もり期間を増やすのではなく、要件定義や設計を固めることでしか上がらない
- 休暇、病欠、トレーニング、ミーティング等は必ず発生する。そのためのゆとりをもたせる
- 開発者の見積もりはすでに必ず楽観的であるので削ってはいけない
- 見積もりに「コントロールノブ」を持たせてはいけない
  - コントロールノブとは見積もりに入れる主観的判断のこと
  - 見積もりの客観性と共に正確性も落ちる
- 即興の見積もりはしない
  - たった15分の見積もりでさえもっと正確になる

## 第2部 見積もりの技法の基礎

### 第7章 数えて、計算して、判断する

- できるときはまず何かを数える
- 数えられない場合にのみ計算する
- 計算すらしないのは最終手段

### 第9章 専門家の判断

- タスクで分解して見積もるときは長くても2日程度の粒度にする


## 感想

「技術者の見積もりは常に楽観的」というのはその通りだと思った。
幅がある見積もりの中で最小の部分を提出する傾向があるような気がしているし、
実際過小に見積もる圧力があるということも書かれていた。

一方で、数えるだけの方がよほど正確に見積もれるというのは不思議だった。さすがにコード行数で数えるのはどうかと思うが。

過去の開発にかかった工数と関連データの保存および可視化が出来ていないと不可能な手法ではあるので、これらの重要性はかなり高い。

生産性向上とか言っておいて生産性を測る指標を可視化していないなんてことがザラにある状態では正確な見積もりなんて望めないということかもしれない。

「ソフトウェア見積もり」を読んだ

## 概要

オライリーから出ている 「レガシーコードからの脱却」

https://www.oreilly.co.jp/books/9784873118864/

を読んだので、重要な章を抜き出してノウハウをメモする。

## 第1部
### 1章 何かが間違っている

ほとんどのソフトウェアは作り方や保守の仕方を間違えている。

ウォーターフォールは最後にまとめてリリースするため一か八かの博打。

### 3章 賢人による新しいアイデア

アジャイルはウォーターフォールよりは良い。

一方で、アジャイルをしているチームも技術プラクティスを上手く使えていないために期待した利益が得られないでいる。

## 第2部
### 4章 9つのプラクティス

1. やり方より先に目的、理由、誰のためかを伝える
2. 小さなバッチで作る
3. 継続的に統合する
4. 協力し合う
5. 「CLEAN」コードを作る
6. まずテストを書く
7. テストでふるまいを明示する
8. 設計は最後に行う
9. レガシーコードをリファクタリングする

### 9章 プラクティス5 「CLEAN」コードを作る
うまくカプセル化されたソフトウェアはアウトサイドインで設計することによって得られる。

- アウトサイドインプログラミング
  - コンシューマの観点で機能を設計する
  - サービスが何をやっているかを示す名前をつける
  - どう動くかは隠す
- インサイドアウトプログラミング
  - 問題を小さな塊に分解し、それらを縫い合わせる
  - 最初に実装してしまうと全体が見えなくなる

「知らぬが仏」という言葉はソフトウェアにおいては常に真である。

CLEANなコードを作る。

- C: Cohesive (凝集性)
- L: Loosely coupled (疎結合)
- E: Encapsulated (カプセル化)
- A: Assertive (断定的)
- N: Nonredundant (非冗長)

名前は説明的、能動的、肯定的なものにし、結果的にシステムがどう変化するのかを反映する。

### 10章 プラクティス6 まずテストを書く

多くのテストを書きすぎたり、実装依存のテストを書いたりするとTDDは上手く行かない。

ふるまいを表すのに必要なテストだけを書く。

「ユニットテスト」のユニットとはふるまいの単位であり、メソッド、クラス、モジュール等ではない。

### 12章 プラクティス8 設計は最後に行う

最初のアーキテクチャレベルの設計というよりはコードの詳細設計的な話。

テストを書いた後にリファクタリングで設計を変えていく方が良い。

### 13章 プラクティス9 レガシーコードをリファクタリングする

コードを変更する場合は一緒にレガシーコードをリファクタリングする。

## 感想
プラクティスの大半はテストが必要というのもあって、上手いテストを書くことが非常に重要だと感じた。

Google本でも書かれていたが、やはりユニットテストだからといってメソッド単位でテストしたり、ホワイトボックステストを書くのは良くない。

最後に設計せよというプラクティスがあったが、そのためにはホワイトボックステストがあってはならないはずである。

この辺りの考えに対する後押しが得られたのが良かった。

「レガシーコードからの脱却」を読んだ

## 概要

オライリーから出ている 「Googleのソフトウェアエンジニアリング」

https://www.oreilly.co.jp/books/9784873119656/

を読んだので以下のような内容について章ごとにメモする。

- 主張されている内容の概要、
- そこから得られたノウハウ、
- その他の感想。

なお、全て個人的な解釈に則って記事を書いており、ノウハウ抽出に不要な部分は大胆にカットしているので、本の内容の詳細は実際に読んで把握することをお勧めします。

## 個人的に印象に残った章

- 2章
- 7章
- 12章

## 第1部 主題

### 1章 ソフトウェアエンジニアリングとは何か

#### 概要

プログラミングとはコードを生産する行為、ソフトウェアエンジニアリングとはそのコードを保守することまでを含んだ時間的な広がりを持つ行為。

対象が違うのだから、プログラミングとソフトウェアエンジニアリングに同じベストプラクティスが通用すると一般に仮定するのは無理。

#### ノウハウ

以下の**Hyrumの法則**というものが紹介されている。

> あるAPIに十分な数のユーザーがいるとき、APIを作った者自身が契約仕様として何を約束しているかは重要ではない。
> 作られたシステムが持つあらゆる観察可能な挙動に関して、それに依存するユーザーが出てくるものである。

したがって、API仕様書に書かれていない変更をする際にも、ユーザーへの聞き取り調査の工数は含めておくのが望ましい。

#### 感想

他にも、スケールする仕組みをつくろう、手戻りを無くすよう早期に問題を発見しよう、とかそんなことが書かれていた。

## 第2部 文化

### 2章 チームでうまく仕事をするには

#### 概要

チームで仕事をするには謙虚と信頼が大事だ、等の一般的によく言われることが書かれていた。

#### ノウハウ

以下の標語が紹介されている。
> 早期に失敗し、高速に失敗し、頻繁に失敗せよ

これを実践するために、一人で黙々と作業するのは止める。誰かに頻繁にフィードバックを求める。

#### 感想

「バス係数」の概念も紹介されている。これは何人のメンバーがバスで轢かれたらプロジェクトが失敗するかという指標。

バス係数が低いと、真面目な人ほど他の人に迷惑がかかるからという理由で休みづらくなる気がする。
それで無理矢理プロジェクトを回すのは絶対によろしくないので、迷惑を顧みないほどの豪胆さが欲しい。
自分は休めるし、プロジェクトが回らなければ上にも人手の必要性が伝わるしで一石二鳥である (実行可能なノウハウかどうかは諸説あるので感想部分に書いた)。

### 3章 知識共有

#### 概要

心理的安全性は大事だとか、知識共有を率先してやることに報酬制度を設けよとかの一般論と、Google内でのレビューフローの事例等が書かれていた。

#### ノウハウ

特になし。

#### 感想

Googleの事例自体は参考になるが、銀の弾丸は無いとも書かれており、結局は自分の組織に合った方法論を構築する必要がある。
そういった意味ですぐに実行可能なノウハウは無かった。

### 4章 公正のためのエンジニアリング

#### 概要

バイアスは常にある、多様性が大事、といったことが書かれていた。
GoogleのAIが黒人とゴリラを間違えて問題になった件とか、その類の話。

#### ノウハウ

特になし

#### 感想

それはそう。くらいの感想だった。

### 5章 チームリーダー入門

#### 概要

リーダーとしてどんなことをするべきかが書かれていた。

#### ノウハウ

章自体がノウハウ集となっているので多すぎて書ききれない。
最も重要だと感じたのは「サーバントリーダーシップ」というキーワードで、可能な限りチームメンバーに仕事を移譲し、
自身はチームメンバーが円滑に仕事をすることができるように仕える、というもの。

#### 感想

リーダーになる機会がもしあれば読み直したいが、社内政治が混沌としていたりするとそう上手くは行かないんだろうなと感じた。

### 6章 スケールするリーダー

#### 概要

**スケールする**リーダー (リーダーのリーダー等) としてどんなことをするべきかが書かれていた。

#### ノウハウ

これも章自体がノウハウ集となっているので多すぎて書ききれない。
最も重要だと感じたのは「いつでも立ち去れ」という標語。結局リーダーがボトルネックになったら意味ないよねということで、
自分が立ち去っても問題なく動くチームにするべきで、具体例として1週間以上休暇を取っても問題なく機能するか等が挙げられていた。

#### 感想

5章と同じ。

### 7章 エンジニアリング生産性の計測

#### 概要

生産性を計測する際の注意点が書かれていた。

#### ノウハウ

ゴール、シグナル、メトリクスを明確に区別する (GSMフレームワーク)。

- ゴール: 達成するべき目標。
- シグナル: ゴールを達成したことを知る手段。必ずしも計測可能である必要はない。
- メトリクス: シグナルの計測可能な代替品。

メトリクスを計測する前に、それを計測した後どう行動するのかを考えるべき。

生産性のゴールにはトレードオフがあるため、一部だけを計測するのはよくない。
QuANTSのゴールを全て計測することで、網羅的に計測ができる。

| 頭文字 | 英語                           | 日本語      |
|-----|------------------------------|----------|
| Qu  | **Qu**ality of the code      | コード品質    |
| A   | **A**ttention from engineers | エンジニアの注意 |
| N   | I**n**tellectual complexity  | 知的複雑性    |
| T   | **T**empo and velocity       | テンポと速度   |
| S   | **S**atisfaction             | 満足       |

#### 感想

生産性向上はよくある組織目標だと思うが、ちゃんと考えたことは無かった。
特にGSMの区別はちゃんとしてみたい。

## 第3部 プロセス

### 8章 スタイルガイドとルール

#### 概要

コーディングスタイルガイドやコードフォーマッター大事だよねくらいのことが書かれていた。

#### ノウハウ

特になし。

#### 感想

そこまで新しい知見はなかったので感想も簡素。

### 9章 コードレビュー

#### 概要

コードレビューにおける恩恵や、Googleでの実施方法などが書かれていた。

#### ノウハウ

特になし。

#### 感想

よくあるプルリクエストのベストプラクティス (変更は小さくしろ、レビュアーのことを考えろ、できることは自動化しろ等) とほぼ変わらない印象だった。

### 10章 ドキュメンテーション

#### 概要

ドキュメントがいかに大事かということ、ドキュメントの管理について、Googleでの実例等について書かれていた。

#### ノウハウ

ドキュメントにはオーナーを付ける。
オーナーがドキュメントの変更をレビューして反映たり、最新化する責任を持つ。

ドキュメントはVCSで管理し、ソースコードと同じ管理方法にする。

#### 感想

Googleでもドキュメントについては改善途中であるらしい。ドキュメントが乱立して陳腐化するのはどこでもよくあることで、それを避けるためにオーナーを付けるのは必須だと感じた。

### 11章 テスト概観

#### 概要

テストは大事だくらいのことが書かれていた。

Googleでのテストは「単体」や「結合」等の文脈では区別されず、テスト規模のみにより大中小に分類されるとのこと。

| テスト規模 | 主な制約 | その他 |
|--|------------------------------|----------|
| 小 | 単一プロセス | sleep禁止、I/O操作禁止、ブロッキング禁止 |
| 中 | 単一マシン (複数プロセス) | localhost意外へのアクセスが禁止 |
| 大 | 複数マシン | 実質制約なし |

#### ノウハウ

破綻してほしくないものは全部テストすべき。
ビヨンセルールと呼ばれる標語に従っておく。

> 「そんなに好きならそいつにテスト付けときゃよかったのに」

#### 感想

概観というだけあってノウハウ的なところは薄かった。

### 12章 ユニットテスト

#### 概要

ユニットテストの範囲、保守性について、書き方についてが書かれていた。

脆いなテスト (無関係な要因でたびたび失敗してしまうテスト) を避けることや、テストにロジックを入れない等の一般的なことが多かった。

#### ノウハウ

脆いテストを避けるために変化しないテストを目指す必要がある。
そのためには*公開API経由で*テストすることが重要である。
公開APIの定義とは、以下の通りである。

> 我々が文章の文脈で「公開API」と述べる場合に実際に言及している対象とは、
> ユニットコードのオーナーであるチームの外部にいるサードパーティに対し、そのユニットが公開しているAPIだ。

これに従えば、WEBのAPIをチーム外に公開している場合、そのAPI内部の実装をメソッド単位でテストする*べきではない*。
そのようなテストは外部との契約に関係がないリファクタリング等で失敗するようになる。つまりは脆いテストである。

#### 感想

メソッド単位でテストするなというのは衝撃があったが、納得感もあった。

これに関しては別記事にしたいと思っている。

### 13章 テストダブル

#### 概要

テストダブルとはテスト時に使われるモックやスタブのこと。

テストダブルの種類や利用法についてまとまっていた。

#### ノウハウ

テストではなるべくテストダブルは使わず、本物の実装を使う方が良い。
テストの実行時間高速化等のメリットと、テストダブルを使用した際のリスク等のデメリットをトレードオフし、適切な場合にのみテストダブルを利用するべきである。

#### 感想

メソッドやクラス単位でテストしようとするとどうしても依存が複雑な場合はモックだらけになってしまう気がする。
前章に従ってメソッド単位でテストせず公開API経由でテストする場合には有効なノウハウに感じた。

### 14章 大規模テスト

#### 概要

大規模テストを実施する場合の考え方について書かれている。

#### ノウハウ

> 優れた設計には、リスクならびにそのリスクの軽減のための大規模テストを見極めるテスト戦略が含まれている。

つまり、設計の時点で起こりうるリスクを考え、それに対する大規模テストについて考えを巡らせておくべきである。

#### 感想

大規模なテストは辛いことが多いが、それでもメリットと天秤に掛けるべきだよねという当たり前なことに気付かされた。

大規模テストを作成する際にもう一度読み返したい。

### 15章 廃止

#### 概要

ソフトウェアの廃止は構築よりも難しいことが多いが、それでも保守コストと天秤に掛けて実施すべきということと、
その際に注意すると良いことについて書かれていた。

#### ノウハウ

特になし。

#### 感想

廃止についてはGoogleだからといって特別良いノウハウがあるわけではなく、結局難しいままなんだなと感じた。

## 第4部 ツール

### 16章 バージョンコントロールとブランチ管理

#### 概要

バージョンコントロールの概説、ブランチ管理のバッドノウハウ (長寿命のdevブランチはNG) 、リポジトリ間の依存関係について書かれていた

#### ノウハウ

特になし。

#### 感想

Googleのモノレポについて少し書かれていたが、なかなか真似しづらいので、もしモノレポ環境になったら読み直そうと思った。

### 17章 Code Search

#### 概要

Googleのコード閲覧、検索のための社内ツールであるCode Searchについて書かれている。

#### ノウハウ

特になし。

#### 感想

社内ツールについては得られる物が少なそうだったので斜め読みした。

### 18章 ビルドシステムとビルド哲学

#### 概要

ビルドシステムの一般的な事柄について書かれていた。

#### ノウハウ

特になし。

#### 感想

一般人はよくあるビルドツールでビルドすることになると思うのでここも読み飛ばした。
ビルドツールを作る側になったら読み直したいと思う。

### 19章 GoogleのコードレビューツールCritique

#### 概要

Googleのコードレビューツールのための社内ツールであるCritiqueについて書かれていた。

#### ノウハウ

特になし。

#### 感想

ここも社内ツールの話なため読み飛ばした。

### 20章 静的解析

#### 概要

静的解析の概説とGoogleの社内ツールであるTricorderについて書かれていた。

#### ノウハウ

特になし。

#### 感想

ここも社内ツールのため省略した。
静的解析も既製品を使うことがほとんどだと思うので、作る側になったら読み直したい。

### 21章 依存関係管理

#### 概要

依存関係をいかにして管理するか、およびセマンティックバージョニングについて書かれていた。

#### ノウハウ

特になし。

#### 感想

これも依存関係管理ツールを作る側になったら読み直したいと思った。
セマンティックバージョニングの限界や最小バージョン更新戦略というものを使うと良いということも紹介されていたが、そこまで役に立つものでもなかったので感想欄に。

### 22章 大規模変更

#### 概要

Google全社で実施されるような大規模変更について書かれていた。

#### ノウハウ

特になし。

#### 感想

Google規模で大規模一斉変更を指揮するような機会は一生来ない可能性の方が高いので斜め読みした。

### 23章 継続的インテグレーション

#### 概要

CIについて、テスト実施のタイミング、GoogleにおけるCIについて書かれていた。

#### ノウハウ

マージ前に実施するべきテストとマージ後に実施するべきテストがある。

開発の高速化のために、マージ前は信頼性が高く高速なテストのみを実施し、マージ後は中大規模テストのような時間がかかり多少不安定でも許容されるテストを実施するべきである。

#### 感想

ノウハウには入れていないが以下のような文言があった。

> CIはアラートである。

アラートはSLOが健全であることを担保し、CIはビルドが健全であることを担保する。
この対比は新しく、まだ模索中のようだが、一理あるなという気はした。

### 24章 継続的デリバリー

#### 概要

CDやリリースに関するベストプラクティスが書かれていた。

#### ノウハウ

> 問題を早期に切り分けられるように、あらゆる機能をフラグで保護すべきだ。

> 各リリースのリスクを低減しつつ、市場に投入するまでの時間を最小化するために、早期かつ頻繁に小さなバッチでリリースすべきだ。

#### 感想

機能フラグに関してはサービス全体の観点では同意するが、分業しているとなかなか難しいような気もした。

一方でリリースを早期に小さなバッチで行う方がより安全であるというのは同意できる。

### 25章 サービスとしてのコンピュート

#### 概要

PaaSやCaaS、サーバーレス等のコンピュートリソースについて書かれていた。

#### ノウハウ

特になし。

#### 感想

組織のコンピュートリソースを選択するような立場に無いので流し読みしたが、特に目新しいことは書かれていなかったように思う。

## まとめ

Googleは世界トップの企業で、その内部について良くまとまっていました。

興味がある人は是非本を読んでみてください。