Skip to content

docs: ADR運用文書を現行ルールへ合わせる - #61

Merged
Ries630 merged 3 commits into
mainfrom
docs/issue-60-align-adr-guidance
Aug 29, 2026
Merged

docs: ADR運用文書を現行ルールへ合わせる#61
Ries630 merged 3 commits into
mainfrom
docs/issue-60-align-adr-guidance

Conversation

@Ries630

@Ries630 Ries630 commented Aug 28, 2026

Copy link
Copy Markdown
Owner

概要

  • ADR の作成基準・書式・更新手順の正を adr skill に一本化
  • docs/adr/template.md を現在の skill テンプレートへ同期
  • 既存の時期別一覧と判断履歴を維持

検証

  • cmp -s docs/adr/template.md ~/.agents/skills/adr/assets/template.md
  • 変更文書の相対リンク検査
  • git diff --check
  • bun run cf-typegen
  • bun run check(format、lint、3系統の型検査、208 tests、production build)

対象外

  • 既存 ADR の本文・ステータスの再評価
  • PWA、Worker、同期処理の動作変更
  • AGENTS.md 全体の再構成

Closes #60

@Ries630 Ries630 added the documentation Improvements or additions to documentation label Aug 28, 2026
@Ries630 Ries630 self-assigned this Aug 28, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: eadf5fe855

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/adr/README.md
Comment thread docs/adr/template.md
実際に検討した案と却下理由を書く。外部制約により選択肢がなかった場合は、この節を削除する。

## 結果
## 受け入れた代償

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge ADR-0017 を置換してからテンプレートを変更してください

この見出し変更は、承認済みの docs/adr/0017-adr-in-repo.md が固定している形式(背景 / 決定 / 検討した代替 / 結果 / 再評価のサイン)を変更しますが、0017 は承認済みのままで置換 ADR も追加されていません。同 ADR が定める「判断変更時は新しい ADR を作り、旧 ADR を廃止にする」という履歴も残らないため、現行テンプレートと承認済み決定のどちらに従うべきかが矛盾します。新しい運用判断を ADR として記録し、0017 のステータスから参照してください。

AGENTS.md reference: AGENTS.md:L159-L162

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@codex この指摘は採用しません。Issue #60 では、新しいADRを作らず、既存ADRの本文・ステータス再評価も対象外と明示しています。ADR-0017 は当時のリポジトリ内運用を残す歴史的記録であり、現在の作成基準・書式の正は adr skill、リポジトリ内の入口は docs/adr/README.md とするのが今回の合意です。ここで置換ADRに同じ書式規範を書けば、正が別ファイルにある内容をADRへ複製する二重管理になるため、変更不要です。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

対応

ご説明の方針を確認しました。この指摘は採用せず、コードおよび文書の変更は行っていません

  • Issue docs: ADR運用文書を現行ルールへ合わせる #60 では、既存 ADR の本文やステータスの再評価は対象外です。
  • ADR-0017 は当時の運用を記録した歴史的文書として維持します。現在も、設計判断を docs/adr/ に保存するという当時の決定内容を記録しています。 docs/adr/0017-adr-in-repo.mdL26-L38
  • 現在の作成基準・書式・更新手順の正は adr skill であり、リポジトリ内の入口は docs/adr/README.md であることが明記されています。 docs/adr/README.mdL3-L8
  • テンプレートには現行のセクションと、置換時の取り扱いが反映されています。 docs/adr/template.mdL7-L29
  • 置換 ADR に同じ書式規範を複製すると二重管理になるため、追加 ADR や ADR-0017 のステータス変更は不要と判断しました。

変更がないため、コミットおよび新しいプルリクエストは作成していません。

確認

  • git status --short --branch
  • git log -1 --oneline
  • nl -ba docs/adr/README.md | sed -n '1,35p'
  • nl -ba docs/adr/template.md | sed -n '1,40p'
  • nl -ba docs/adr/0017-adr-in-repo.md | sed -n '1,90p'

View task →

Ries630 added 2 commits August 28, 2026 15:48
domain-modeling skill が用語とコンテキスト境界を担い、CONTEXT.md を必要時に作成・更新する責務を明確にする。
@Ries630
Ries630 merged commit a04210d into main Aug 29, 2026
1 check passed
@Ries630
Ries630 deleted the docs/issue-60-align-adr-guidance branch August 29, 2026 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: ADR運用文書を現行ルールへ合わせる

1 participant