Skip to content

【ライティングレビュー ロット11】AWS設計 - #369

Merged
ma91n merged 5 commits into
mainfrom
feature/tw-review-lot11-aws
Aug 3, 2026
Merged

【ライティングレビュー ロット11】AWS設計#369
ma91n merged 5 commits into
mainfrom
feature/tw-review-lot11-aws

Conversation

@ma91n

@ma91n ma91n commented Aug 2, 2026

Copy link
Copy Markdown
Collaborator

テクニカルライティングガイドラインに沿って、AWS設計ガイドラインをレビューした。削減を最優先とし、次に構造化、一文一義の順で対応している。

対象は documents/forAWS/aws_guidelines.md の1ファイルのみ。

変更規模

項目 変更前 変更後
本文の文字数 144,582 143,515(-1,067字
prettier整形後のファイルサイズ 144,582 142,340(-2,242字)
行数 1,587 1,585

本文の削減は1,067字。表セルを短くした結果、prettierによる列揃えのパディングがさらに約1,180字減っているため、ファイルサイズ上の差分はそれより大きく出ている。

本文書は全体の6〜8割が比較表(表の行は417行)で、技術的な主張・推奨・理由・具体値は削らない方針のため、削減率自体は控えめである。

コミット構成

レビューしやすいよう3コミットに分けている。

  1. ライティングレビュー: AWS設計ガイドライン — 本題
  2. ページ内リンク切れの修正とカタカナ長音表記の統一 — 副次的に見つかった不具合の修正
  3. コンピューティング試算の計算誤りと乗算記号の修正 — 検証できた計算誤りの修正(後述)

主な変更

削減

  • 「コストの最適化」章冒頭の「AWSを利用する上でコストは切っても切り離せないテーマである。」を削除(比喩のみで情報量がなく、直後の段落が実質の導入)
  • 表セルの水増しを全表にわたって圧縮。行ラベルとの重複(「入力のバリデーション」行の「✅️入力バリデーションの設定でAPI Gatewayにて対応可能」→「✅️API Gatewayのバリデーション設定で対応可能」)、「〜することが可能」「〜する必要がある」「〜であり、〜」の一括圧縮など
  • 要求事項マトリクスの「特徴」行4セルで、行見出しと重複する末尾「〜点が特徴」を削除して常体の言い切りに統一
  • API Gateway考慮事項、api.yaml 導入文、ロードバランサー選定導入文、ECS間通信の推奨、CI/CD各パイプラインの連携の導入
  • SecurityHub検知結果の運用、Macieの推奨、Identity Center不採用の理由

構造化

  • ロググループ集約に関する対立意見の散文(226字の1段落)を、「集約したい/分離したい」の箇条書き2項目に
  • 「テストについて」の195字の一文を、「パイプライン内で実行する高速テスト」「別スケジュールで実行する時間のかかるテスト」の2項目に
  • SecurityHub基準の推奨を結論先行に分割し、同章の他の推奨と同じ「推奨+理由サブ項目」の型に統一(連番 No1、4 は方式名に置換せず保持)
  • 「EC2の試算は以下。」+1項目だけの箇条書き、リセラー特典の1項目リストを、それぞれ1文に統合
  • ストレージクラス表の「対象」列を全行「〜データ」止めに統一

一文一義

api.yaml の要件バランス文(読点で3要件を連結)を3文に、S3レプリケーション監視の多段因果を3文に、Identity Center不採用の理由を3文に分割したほか、単純接続の「〜が」を「ただし」等で分割した。

ついでに直した誤記(抜粋)

修正前 修正後
CloudTrai CloudTrail
Custom Aurhorizer Custom Authorizer
OpenAPI Specifitaion OpenAPI Specification
Compute Savig Plans Compute Savings Plans
メトリスク監視 メトリクス監視
Deep Heahth Check Deep Health Check
パイプラインごとの債務が明確 責務が明確
1カウントあたりのロググループ数 1アカウント
下表の2つの手法が考えられる 3つの手法(表は松竹梅の3案)
ツリー上位のポリシ**-**(全角ハイフンマイナス) ポリシ
実行時間が高いテスト 実行時間の長いテスト
CICD CI/CD
大量アクセスブロックする ブロックする

ほか、句点・全角スペースの混入、係り受け破綻、バッククォート範囲の誤り(セル全体をコードスパンにしていた箇所など)を含め計60箇所ほど。

また [DynamoDB のメトリクスとディメンション によると、32のメトリクス項目が存在する。](URL) のように文全体がリンクテキストになっていた箇所を、他節と同じく見出し語のみのリンクに直した。

ページ内リンク切れとカタカナ表記の統一(2つ目のコミット)

レビュー前から存在していた不具合

  • VitePressが生成する見出しIDは濁点・半濁点が分解された形になるため、[マルチアカウントを利用した環境分離パターン](#マルチアカウントを利用した環境分離パターン) など計5リンクが機能していなかった。該当4見出しに明示アンカー(ASCII)を付与して解消
  • バッチ設計ガイドラインの「バッチ実行モデル(AWS)」への参照も同じ理由で機能していなかったため、【ライティングレビュー ロット10】バッチ設計 #367 で付与したアンカー #batch-execution-model に更新(【ライティングレビュー ロット10】バッチ設計 #367 のマージが前提
  • 「ユーザ」表記4箇所を「ユーザー」に統一(長音ありの方針に合わせた)

ビルド後のHTMLからIDを抽出し、本文中の全ページ内リンクおよび他文書への6リンクがすべて解決することを機械的に確認済み。

コンピューティング試算の計算誤りの修正(3つ目のコミット)

隣接行から正しい値が一意に導けたため修正した。意図が異なる場合は差し戻したいので確認をお願いしたい。

修正前 修正後 根拠
請求対象コンピューティング時間: 41,472,000 - 400,000 = 20,336,000 GB秒 20,736,000 - 400,000 = 20,336,000 2行上の「合計コンピューティング時間/月」が 20,736,000 GB秒。左辺が 41,472,000 では右辺と一致しない(41,072,000になる)。右辺の 20,336,000 は直後のコンピューティング料金 $338.93 の算出に使われており正しい
日本円換算: $705.08 * 150円/ドル ≈ 53,920.5円 $359.47 * 150円/ドル ≈ 53,920.5円 直前行の合計月額が $359.47。53,920.5 ÷ 150 = 359.47
リクエスト料金: … _ $0.20 … \* $0.20 乗算記号が _ になっていた(他行は *)。レンダリング結果にもそのまま _ が出ていた
月額コントロールプレーン費用: $0.10/時間 _ 730時間/月 = $73_ 150円/ドル ≈ 10,950 円 $0.10/時間 * 730時間/月 = $73。$73 * 150円/ドル ≈ 10,950 円 同上。あわせて2つの計算が1文に連結していたのを分割

検証

  • 見出し数: h1=9 / h2=24 / h3=19 / h4=6 で変更前と一致(章・節の欠落なし)
  • コンテナ(:::)58、コードブロック(```)6、表の行417 — いずれも変更前と一致。表456行すべてで列数が変更前と一致(セル編集による表崩れなし)
  • 削除のみのハンクは1件のみで、上記「コストの最適化」章冒頭の1文(意図した削除)
  • 4ブロック分割レビューの削減量合計(257+307+313+190=1,067字)と実測差分が完全に一致しており、並行編集による欠落がないことを確認
  • textlint: エラー0
  • prettier: 整形済み
  • markdownlint: 0件(変更前も0件)
  • VitePressビルド: 成功

著者確認事項(すべて解決済み)

コミット 著者確認反映: ENIアタッチ・Kinesisの対象モード・アカウント名称の統一など11件 で反映済み。未解決の確認事項は残っていない。

# 内容 対応
1 EIPアタッチENIアタッチ の誤りではないか ✅ 修正: 2箇所を ENIアタッチ
2 Kinesis推奨の対象モードが逆ではないか ✅ 修正: 「プロビジョンドの場合はシャード追加などを行う」
3 DynamoDBの ConsumedReadCapacityUnits/AccountMaxTableLevelReads の対象モード ⏭ 技術的な検討が必要なため #370 として起票。本PRでは変更しない
4 S3 Intelligent-Tiering警告の論理矛盾を修正済み ✅ 修正内容で確定(「常に高頻度アクセス階層に配置する」)
5 SavingsPlansの推奨理由が固有の理由になっていない ✅ 対応不要: このままで問題なし
6 CodeCommitの推奨とGA復帰の整合 ✅ 対応不要: 一度新規利用が停止された経緯そのものを信頼度の低さの根拠としているため、現状の記述で意図どおり
7 Fargate/ECS on EC2の推奨の論理が未完結 ✅ 修正: 「例えば、〜工数が大幅に増えるなどがある場合」→「ただし、〜工数が大幅に増える場合はFargateを選択する」と結論を補った
8 Step Functions推奨の「設定不可」の主体が不明 ✅ 修正: 意図(最大実行時間はステートマシンごとに異なるため一律のしきい値がミスマッチ)に沿って「ExecutionTime で実行時間を監視できる。ただし、最大実行時間はステートマシンごとに異なるため、一律のしきい値を設定しても有効に機能しない。」に書き換え
9 CORS対応の説明の主語が不明瞭 ✅ 修正: 「CORS対応では、正常パスであってもプリフライトリクエストが必ず到達するため」と主語を明示
10 「Fargateは想像以上に性能が出ない」の出典 ✅ 対応不要: 出典を明示できない事情があるため現状のまま
11 CodeCommitの参考infoで2つの記事リンクが同一URL ✅ 修正: 移行方法の記事を正しいURL(.../how-to-migrate-your-aws-codecommit-repository-to-another-git-provider/)に差し替え。リンク先が実在し、タイトルが一致することも確認済み
12 課金体系表のヘッダ構造 ✅ 対応不要: このままで問題なし
13 SecurityHubの表記ゆれ ✅ 対応不要: 別Issueで起票済みのため本PRでは変更しない
14 アカウント名称のゆれ ✅ 修正: 「セキュリティ管理アカウント」「セキュリティサービス管理用のアカウント」→セキュリティサービス用アカウント、「集約管理アカウント」→管理アカウント、「ログ保管用アカウント」→監査・ログ管理アカウント に統一
15 EC2Instance Savings Plans のスペース欠落 ✅ 修正: 2箇所を EC2 Instance Savings Plans
16 「AWS バックアップ」と「AWS Backup」の表記ゆれ ✅ 修正: 2箇所を AWS Backup に統一
17 ## スケジューラ のリンクテキストの妥当性 ✅ 対応不要: このままで問題なし
18 ## SPAのホスティング のリンク先 ✅ 修正: Webフロントエンド設計ガイドラインの # ホスティング方式 から ## SPAのホスティング へ変更
19 Macie検出結果タイプ表のAWS公式訳が崩れている 引用のため現状維持
20 「後述のVuls」の前後関係 現状維持

リンク先の変更(11・18)については、ビルド後のHTMLからIDを抽出し、ページ内リンクおよび他文書への6リンクがすべて解決することを再確認済み。

🤖 Generated with Claude Code

@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@ma91n
ma91n marked this pull request as draft August 3, 2026 05:28
@ma91n
ma91n marked this pull request as ready for review August 3, 2026 07:15
@ma91n
ma91n merged commit f7f12c8 into main Aug 3, 2026
1 check passed
@ma91n
ma91n deleted the feature/tw-review-lot11-aws branch August 3, 2026 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant