Skip to content

docs: 完了の知らせ・編集中の画面・ボタンの語彙を原則と文言の規則に足す - #34

Merged
tkc310 merged 2 commits into
mainfrom
docs/editing-flow
Nov 7, 2026
Merged

tkc310 merged 2 commits into
mainfrom
docs/editing-flow

Conversation

@tkc310

@tkc310 tkc310 commented Nov 7, 2026

Copy link
Copy Markdown
Owner

Requested by tkc310 · project thread

変更内容

bouzu の読誦セット(tkc310/bouzu#73・#80)とホーム(#81)で直した「画面の流れ」と「ボタンの語」を、8341-ui を使うどのプロダクトでも同じにできるよう、原則(正本)と文言の規則に足します。部品のコードは変えていません。

なぜ: bouzu では、ボタンの語(直す・消す・やめる・加える)がほかの画面やウェブの慣習と違い、編集の欄が一覧の上に出てどれを直しているか分からず、保存しても済んだのか分からずスクロールも編集のときのままでした。ホームの入口とメニューを別々に書いていたため、メニューにある画面がホームからたどれませんでした。どれも原則の必須(同じ機能は同じラベル、完了を表示する)には沿っていたものの、具体的な形が決まっていなかったのが原因です。

  • docs/design-principles/principles.md「状態と応答」の推奨に 3 つ追加
    • 保存・更新・削除の結果を一文で上部に出す。時間で消さず、閉じるか次の作成・編集を始めるまで残す。キャンセルでは出さない
    • 作成・編集中は一覧の代わりに編集の画面だけを出し、「『○○』を編集」を見出しにしてフォーカスを移す
    • 一覧に戻ったら、結果が見える位置(先頭)へスクロールを戻す
  • 同「一貫性」の推奨: トップページの機能一覧とナビゲーションを一つの定義から作る
  • レビュー項目を 2 つ追加(design-review で確かめられる)
  • docs/rulebook/05-writing.md: ボタンの語彙の表(新しい○○を作る / 編集 / 削除 / 削除する / 保存する / キャンセル / 外す)、行のボタンは見える文字を短くして読み上げの名前に対象を入れること、確認・完了・空の一覧の書き方

必須には足していないので、プロダクト用 DESIGN.md の原則の要約(templates/PRODUCT-DESIGN.md)は変わりません。

Storybook プレビュー

なし

完了の定義

  • PR のタイトルが Conventional Commits の形式
  • make check と make test が通る
  • changeset は不要(公開パッケージを変えていない)
  • ライト / ダーク: 見た目は変わらない
  • キーボード: 部品は変えていない
  • 新しい semantic カラーは足していない
  • 値や方針を変えた場合、ADR を足した(原則の推奨の追加のため足していません。ADR が要る判断なら書きます)

改善ループ

  • docs/improvement/log.md に 1 行追記した
  • 再発防止として追加したもの: 原則のレビュー項目 2 つ

Generated by Claude Code

- 状態と応答の推奨: 完了の知らせは時間で消さずキャンセルでは出さない、編集中は一覧の代わりに編集の画面だけを出す、戻ったら先頭へスクロール
- 一貫性の推奨: 機能一覧とナビゲーションを一つの定義から作る
- 05 文言: ボタンの語彙の表、確認・完了・空の一覧の書き方

bouzu(tkc310/bouzu#73・#80・#81)での知見を反映。

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01S5dPLGGVzZyRz8dob3cTmz
@tkc310 tkc310 self-assigned this Nov 7, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01S5dPLGGVzZyRz8dob3cTmz
@tkc310
tkc310 merged commit 619477b into main Nov 7, 2026
3 checks passed
@tkc310
tkc310 deleted the docs/editing-flow branch November 7, 2026 00:27
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.

2 participants