Repository navigation
feat(registry): 8341-ui を使うプロダクトに DESIGN.md と design-principles を配る @8341/design-md を追加 - #27
Merged
Merged
Conversation
原則「削る」に、部品を組み合わせたページで適用するルールを追加した。 - 必須: 見出し・配置・まとまりで伝わることを、小見出し・補助ラベル・説明文で繰り返さない - 必須: 項目どうしの関係(グループ・主従)はレイアウトで示し、説明文で補わない - 必須: 削るのは重複した表示だけ。入力欄の見えるラベル(WCAG 3.3.2)と構造(1.3.1)、アイコンだけの操作の名前は残す - 推奨: 補足文が要りそうなら、先に配置・見出し・ラベルの語を直す - 出典カタログ(ゲシュタルトの近接・共通地域)、ルールブック 01・05、DESIGN.md の Don't に反映 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Yb44feYKDNj2ukQeT2j8Ks
…8341/design-md を追加 - レジストリ item `design-md`: リポジトリ直下に DESIGN.md、docs/design-principles/ に原則の全文を置く - プロダクト用 DESIGN.md(templates/PRODUCT-DESIGN.md)を、コードから読み取れない考え方だけの構成に書き直した(プロダクトの前提・画面領域ごとの方向性・大事にすること・外した必須)。トークンや部品の一覧は載せない - 原則の要約(判断の順序・ルールの強さ・方向性と各原則の必須)は scripts/sync-product-design.ts が docs/design-principles から生成し、make check で鮮度を検査 - build-registry-css.ts を build-registry-assets.ts に改名し、DESIGN.md と原則(ファクトリーの部分を除く)も registry-assets/ に作る - README のクイックスタート、ds-build-ui、DESIGN.md、ルールブック 01、design-principles/README を更新。ADR-0019、changeset、改善ログ Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Yb44feYKDNj2ukQeT2j8Ks
7 of 8 tasks
# Conflicts: # docs/improvement/log.md
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.
変更内容
8341-ui の部品を使うプロダクトにも、デザイン原則が DESIGN.md として届くようにしました(ADR-0019)。これまでは雛形を手でコピーし、原則は GitHub のリンクで読む前提で、プロダクト側のエージェントは原則を参照できませんでした。
使い方(プロダクト側)
npx shadcn@latest add @8341/design-md # リポジトリ直下に DESIGN.md、docs/design-principles/ に原則の全文プロダクト用 DESIGN.md の中身
コードから読み取れない設計の考え方だけ を書く構成にしました。トークンの値や部品の一覧はコードが正なので載せません。
<!-- auto:principles -->。判断の順序・ルールの強さ・UI の方向性と 15 の原則の必須)冒頭の「エージェントへ」で、空欄は
hearing.mdの項目で聞いて埋めること、詳しくはdocs/design-principles/の該当節だけを読むことを指示しています。仕組み
scripts/sync-product-design.ts: 原則の要約をdocs/design-principles/から生成(make design-md)。make checkで鮮度を検査。15 の原則すべてで、必須の件数が元の文書と一致することを確認済みpackages/ui/scripts/build-registry-assets.ts(旧build-registry-css.ts): DESIGN.md と原則もregistry-assets/に作る。原則の文書からはファクトリーの部分を除く。仮のトークンで実行し、配るファイルの一覧が registry.json と一致することを確認済みgenerate-registry.ts:design-md(registry:file、targetは~/DESIGN.mdと~/docs/design-principles/…。~はプロジェクトのルート)../ai-agents.md)を GitHub の URL にし、「プロダクトで使う」節を足したStorybook プレビュー
なし(コンポーネントとトークンの見た目は変更なし)
完了の定義
make checkとmake testが通る(CI で確認。sync-product-design --check・generate-registry --check・スキルとスライドの検査は手元で通過)docs/decisions/に ADR を足した(0019)マージ後、main の CI が
shadcn buildでr/design-md.jsonを公開します(~の target はこのリポジトリで初めて使うため、公開後に実際の取り込みを確認するのが安全です)。改善ループ
docs/improvement/log.mdに 1 行追記したsync-product-design.ts --check(make check)、配る原則のファイル一覧の registry.json での追従Generated by Claude Code