【ライティングレビュー ロット11】AWS設計 - #369
Merged
Merged
Conversation
|
|
ma91n
marked this pull request as draft
August 3, 2026 05:28
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
テクニカルライティングガイドラインに沿って、AWS設計ガイドラインをレビューした。削減を最優先とし、次に構造化、一文一義の順で対応している。
対象は
documents/forAWS/aws_guidelines.mdの1ファイルのみ。変更規模
本文の削減は1,067字。表セルを短くした結果、prettierによる列揃えのパディングがさらに約1,180字減っているため、ファイルサイズ上の差分はそれより大きく出ている。
本文書は全体の6〜8割が比較表(表の行は417行)で、技術的な主張・推奨・理由・具体値は削らない方針のため、削減率自体は控えめである。
コミット構成
レビューしやすいよう3コミットに分けている。
ライティングレビュー: AWS設計ガイドライン— 本題ページ内リンク切れの修正とカタカナ長音表記の統一— 副次的に見つかった不具合の修正コンピューティング試算の計算誤りと乗算記号の修正— 検証できた計算誤りの修正(後述)主な変更
削減
api.yaml導入文、ロードバランサー選定導入文、ECS間通信の推奨、CI/CD各パイプラインの連携の導入構造化
一文一義
api.yamlの要件バランス文(読点で3要件を連結)を3文に、S3レプリケーション監視の多段因果を3文に、Identity Center不採用の理由を3文に分割したほか、単純接続の「〜が」を「ただし」等で分割した。ついでに直した誤記(抜粋)
CloudTraiCloudTrailCustom AurhorizerCustom AuthorizerOpenAPI SpecifitaionOpenAPI SpecificationCompute Savig PlansCompute Savings Plansほか、句点・全角スペースの混入、係り受け破綻、バッククォート範囲の誤り(セル全体をコードスパンにしていた箇所など)を含め計60箇所ほど。
また
[DynamoDB のメトリクスとディメンション によると、32のメトリクス項目が存在する。](URL)のように文全体がリンクテキストになっていた箇所を、他節と同じく見出し語のみのリンクに直した。ページ内リンク切れとカタカナ表記の統一(2つ目のコミット)
レビュー前から存在していた不具合。
[マルチアカウントを利用した環境分離パターン](#マルチアカウントを利用した環境分離パターン)など計5リンクが機能していなかった。該当4見出しに明示アンカー(ASCII)を付与して解消#batch-execution-modelに更新(【ライティングレビュー ロット10】バッチ設計 #367 のマージが前提)ビルド後のHTMLからIDを抽出し、本文中の全ページ内リンクおよび他文書への6リンクがすべて解決することを機械的に確認済み。
コンピューティング試算の計算誤りの修正(3つ目のコミット)
隣接行から正しい値が一意に導けたため修正した。意図が異なる場合は差し戻したいので確認をお願いしたい。
41,472,000-400,000=20,336,000GB秒20,736,000-400,000=20,336,00020,736,000GB秒。左辺が41,472,000では右辺と一致しない(41,072,000になる)。右辺の20,336,000は直後のコンピューティング料金 $338.93 の算出に使われており正しい$705.08* 150円/ドル ≈ 53,920.5円$359.47* 150円/ドル ≈ 53,920.5円_$0.20 …\*$0.20_になっていた(他行は*)。レンダリング結果にもそのまま_が出ていた_730時間/月 = $73_150円/ドル ≈ 10,950 円検証
:::)58、コードブロック(```)6、表の行417 — いずれも変更前と一致。表456行すべてで列数が変更前と一致(セル編集による表崩れなし)著者確認事項(すべて解決済み)
コミット
著者確認反映: ENIアタッチ・Kinesisの対象モード・アカウント名称の統一など11件で反映済み。未解決の確認事項は残っていない。EIPアタッチはENIアタッチの誤りではないかENIアタッチにConsumedReadCapacityUnits/AccountMaxTableLevelReadsの対象モードExecutionTimeで実行時間を監視できる。ただし、最大実行時間はステートマシンごとに異なるため、一律のしきい値を設定しても有効に機能しない。」に書き換え.../how-to-migrate-your-aws-codecommit-repository-to-another-git-provider/)に差し替え。リンク先が実在し、タイトルが一致することも確認済みEC2Instance Savings Plansのスペース欠落EC2 Instance Savings PlansにAWS Backupに統一## スケジューラのリンクテキストの妥当性## SPAのホスティングのリンク先# ホスティング方式から## SPAのホスティングへ変更リンク先の変更(11・18)については、ビルド後のHTMLからIDを抽出し、ページ内リンクおよび他文書への6リンクがすべて解決することを再確認済み。
🤖 Generated with Claude Code