Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BCCDデザインに関するドキュメントの作成 #367

Merged
merged 16 commits into from
Jan 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [環境構築](docs/installation.md)
- [コマンド一覧](docs/commands.md)
- [使用技術](docs/tech.md)
- [アーキテクチャ](docs/architecture.md)

## 参照

Expand Down
44 changes: 44 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# アーキテクチャ
tyokinuhata marked this conversation as resolved.
Show resolved Hide resolved

## コンポーネント

BCCD Designを元に、以下のルールに沿ってコンポーネントの設計を行う。

### 分類方法

- Base
- 役割: 基礎
- 品詞: 名詞
- 説明: 基礎的な機能(名詞)や、事実上の型を表現する
- 例: Button/Icon/Image
- Case
- 役割: 状況
- 品詞: 動詞/形容詞/名詞
- 説明: 状況(動詞/形容詞)や状態(名詞)を表現する
- 例: Alert/Edit/Post
- Common
- 役割: サービス横断的な関心
- 品詞: 名詞
- 説明:
- 幅広く共通して利用可能な、横断的な関心を表現する
- 複数ページ/箇所で使えるレベルに特化されたコンポーネント
- 例: Category/Error/Tag
- Domain
- 役割: サービス限定的な関心
- 品詞: 名詞
- 説明:
- 人(ロール)や物(名詞)など、限定的な関心を表現する
- 特定ページ/箇所でしか使えないレベルに特化されたコンポーネント
- 例: Community/Product/User

### 留意点

- 依存関係の方向はBase <- Case <- Common <- Domainとする
- Domain以外のコンポーネントは同じ分類同士で依存させない
- 本来、Baseに分類されるべきだが、Baseに依存してしまうようなコンポーネントは、Commonに定義する

### 参照

- [https://qiita.com/misuken/items/19f9f603ab165e228fe1](https://qiita.com/misuken/items/19f9f603ab165e228fe1)
- [https://qiita.com/misuken/items/d51c181487cf611821f4](https://qiita.com/misuken/items/d51c181487cf611821f4)
- [https://qiita.com/misuken/items/09498a496511034627af](https://qiita.com/misuken/items/09498a496511034627af)
5 changes: 0 additions & 5 deletions docs/tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@

- [Figma](https://www.figma.com/)

## アーキテクチャ

- [BEM](https://en.bem.info)
- [BCCD Design](https://qiita.com/misuken/items/19f9f603ab165e228fe1)

## スタイリング

- [the-new-css-reset](https://github.com/elad2412/the-new-css-reset)
Expand Down
Loading