Skip to content

docs: ADR の本文の、比喩など不自然な言い回しを直す(判断と理由は変えない) - #607

Merged
taminororo merged 4 commits into
developfrom
docs/kanba/605/yomiyasu-adr
Oct 3, 2026
Merged

taminororo merged 4 commits into
developfrom
docs/kanba/605/yomiyasu-adr

Conversation

@taminororo

@taminororo taminororo commented Oct 3, 2026 •

Copy link
Copy Markdown
Collaborator

対応Issue

ref #605

概要

ADR(docs/decisions/ の README・template・0001〜0021)を、文章を読みやすく直すスキル yomiyasu の決まりで、develop の原文から書き直しました。判断・理由・選ばなかった案の中身、「状態」の行、「前提」欄のパスとシンボル、追記の日付は変えていません。

  • 和欧文間の半角空白をなくしました。ADR のタイトルも変わるので、README.md の一覧の表のタイトルもそろえ、21 本すべてで一致することを確かめました
  • 比喩を直しました(「道」→「ルート」、「見回って」→「30秒ごとにテーブルを確かめて」、「埋め込みを拒む」→「埋め込んで表示できない」など)
  • 前提欄の「ラベル:path」は「ラベルはpath」の形にしました(パスとシンボルは同じ)
  • README.md の段落の頭の太字(12個→2個)と、0013・0014・0019 などの説明だけの箇条書きを地の文にしました
  • 「壊れる」「崩れる」は、別の抽象的な言葉にせず、何が起きるかを書きました。例:

この PR を分けた理由

docs/decisions/README.md に「本文は書き換えず、追記します。書いた後で変えてよいのは、「状態」の行、末尾の「追記」、誤字、…」という決まりがあります。今回の直しは判断の中身を変えませんが、誤字の直しより広いので、マージするかを決めてから扱うために PR を分けました。マージしない場合は、この PR を閉じます。ADR 以外の文書の直しは #606 です。

画面スクリーンショット等

なし(ドキュメントのみ)

テスト項目

  • 書き直した文で、判断や理由の意味が変わっていないか
  • python3 scripts/refcheck/refcheck.py docs/decisions/*.md が通ること(手元で確認済み)

備考

  • マージする場合は、README.md の決まりに「判断の中身を変えない言い回しの直し」を足すかも、あわせて決めたほうがよいです

@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 13 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: NUTFes/SeeFT/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 417f6912-b7b2-4bbe-83dd-16c9d82f9628
📥 Commits

Reviewing files that changed from the base of the PR and between 73f6dd7 and 651000b.

📒 Files selected for processing (23)
  • docs/decisions/0001-record-decisions.md
  • docs/decisions/0002-di-wiring-only.md
  • docs/decisions/0003-maintenance-over-features.md
  • docs/decisions/0004-develop-merge-by-admin.md
  • docs/decisions/0005-task-year-id-not-filtered.md
  • docs/decisions/0006-manual-serving-google-gate.md
  • docs/decisions/0007-gas-live-is-source.md
  • docs/decisions/0008-manual-link-by-name.md
  • docs/decisions/0009-mobile-web-only.md
  • docs/decisions/0010-prod-auto-restart.md
  • docs/decisions/0011-shift-notice-dm-only.md
  • docs/decisions/0012-slack-id-linked-by-gas.md
  • docs/decisions/0013-rescue-dm-sent-immediately.md
  • docs/decisions/0014-manual-open-in-new-tab.md
  • docs/decisions/0015-manual-html-not-pdf.md
  • docs/decisions/0016-simple-manual-pdf-on-drive.md
  • docs/decisions/0017-manual-ops-not-automated.md
  • docs/decisions/0018-test-mock-with-sqlmock.md
  • docs/decisions/0019-test-outside-in.md
  • docs/decisions/0020-bundle-subset-japanese-font.md
  • docs/decisions/0021-static-server-threaded-gzip.md
  • docs/decisions/README.md
  • docs/decisions/template.md
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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