cc_make_components_docs - corollazer0/nhcx2025 GitHub Wiki
์ปดํฌ๋ํธ ๊ฐ์ด๋ ๋ฌธ์ ์์ฑ ๋ฒ์ฉ ํ๋กฌํํธ
๋ค์ ํ๋กฌํํธ๋ฅผ ์ฌ์ฉํ์ฌ ๊ฐ ์ปดํฌ๋ํธ๋ณ ๊ฐ์ด๋ ๋ฌธ์๋ฅผ ์์ฑํ์ธ์:
๐ ํ๋กฌํํธ ํ ํ๋ฆฟ
[์ปดํฌ๋ํธ๋ช
] ์ปดํฌ๋ํธ์ ๊ฐ๋ฐ์ ๊ฐ์ด๋ ๋ฌธ์๋ฅผ /docs/{component๋ช
}.md ํ์ผ๋ก ์์ฑํด์ฃผ์ธ์.
๋ค์ ๊ตฌ์กฐ์ ๋ด์ฉ์ ํฌํจํ์ฌ ์์ฑํด์ฃผ์ธ์:
### ํ์ ํฌํจ ๋ด์ฉ:
1. **์ปดํฌ๋ํธ ๊ฐ์** - ์ปดํฌ๋ํธ์ ๋ชฉ์ ๊ณผ ์ฃผ์ ๊ธฐ๋ฅ
2. **์ค์น ๋ฐ Import** - ์ปดํฌ๋ํธ ์ฌ์ฉ์ ์ํ ์ค์น/import ๋ฐฉ๋ฒ
3. **Props API** - ๋ชจ๋ props์ ํ์
, ๊ธฐ๋ณธ๊ฐ, ์ค๋ช
์ ํ ํํ๋ก ์ ๋ฆฌ
4. **Events API** - emit๋๋ ์ด๋ฒคํธ๋ค์ ์ค๋ช
๊ณผ ํ๋ผ๋ฏธํฐ
5. **๊ธฐ๋ณธ ์ฌ์ฉ๋ฒ** - ๊ฐ์ฅ ์ผ๋ฐ์ ์ธ ์ฌ์ฉ ์์ ์ฝ๋
6. **์ฌ์ฉ ์ฌ๋ก๋ณ ์์ ** - ๋ค์ํ ์ํฉ๋ณ ์ค์ ๊ตฌํ ์์
7. **์คํ์ผ๋ง ๊ฐ์ด๋** - CSS ํด๋์ค, ๋์์ธ ํ ํฐ, ์ปค์คํฐ๋ง์ด์ง ๋ฐฉ๋ฒ
8. **์ ๊ทผ์ฑ (Accessibility)** - ํค๋ณด๋ ๋ด๋น๊ฒ์ด์
, ์คํฌ๋ฆฐ ๋ฆฌ๋ ์ง์ ๋ฑ
9. **์ฌ์ฉ ๊ถ์ฅ์ฌํญ** - ์ฌ๋ฐ๋ฅธ ์ฌ์ฉ๋ฒ, ํผํด์ผ ํ ํจํด, ์ฑ๋ฅ ์ต์ ํ ํ
10. **๋ฌธ์ ํด๊ฒฐ** - ์์ฃผ ๋ฐ์ํ๋ ๋ฌธ์ ์ ํด๊ฒฐ ๋ฐฉ๋ฒ
11. **๊ด๋ จ ์ปดํฌ๋ํธ** - ํจ๊ป ์ฌ์ฉ๋๋ ์ปดํฌ๋ํธ๋ค์ ๋งํฌ
12. **๋ณ๊ฒฝ ์ด๋ ฅ** - ์ฃผ์ ๋ฒ์ ๋ณ ๋ณ๊ฒฝ์ฌํญ
### ์์ฑ ๊ฐ์ด๋๋ผ์ธ:
- ๊ฐ๋ฐ์ ๊ด์ ์์ ์ค์ฉ์ ์ด๊ณ ๊ตฌ์ฒด์ ์ธ ์ ๋ณด ์ ๊ณต
- ์ฝ๋ ์์ ๋ ์ค์ ๋์ ๊ฐ๋ฅํ ์์ ํ ํํ๋ก ์์ฑ
- ๊ฐ prop๊ณผ event์ ๋ํ ์์ธํ ์ค๋ช
๊ณผ ์ฌ์ฉ ์๋๋ฆฌ์ค ํฌํจ
- Do/Don't ํํ์ ๊ถ์ฅ์ฌํญ์ผ๋ก ๋ฒ ์คํธ ํ๋ํฐ์ค ์ ์
- ์ปดํฌ๋ํธ๋ณ ํน์ฑ์ ๋ฐ์ํ ๋ง์ถคํ ๊ฐ์ด๋ ์์ฑ
- ๋งํฌ๋ค์ด ๋ฌธ๋ฒ์ ํ์ฉํ ๊ฐ๋
์ฑ ๋์ ๋ฌธ์ ๊ตฌ์กฐ
ํ์ฌ ์ปดํฌ๋ํธ์ .vue, .stories.ts, .spec.ts ํ์ผ์ ๋ถ์ํ์ฌ ์ ํํ ์ ๋ณด๋ฅผ ๋ฐํ์ผ๋ก ๋ฌธ์๋ฅผ ์์ฑํด์ฃผ์ธ์.
๐ง ์ฌ์ฉ ๋ฐฉ๋ฒ
- ์ ํ๋กฌํํธ ํ
ํ๋ฆฟ์์
[์ปดํฌ๋ํธ๋ช ]
๊ณผ{component๋ช }
์ ์ค์ ์ปดํฌ๋ํธ๋ช ์ผ๋ก ๋ณ๊ฒฝ - ํด๋น ์ปดํฌ๋ํธ์ ์์ค ์ฝ๋๋ฅผ ๋จผ์ ๋ถ์
- ํ๋กฌํํธ๋ฅผ Claude์๊ฒ ์ ๋ฌํ์ฌ ๊ฐ์ด๋ ๋ฌธ์ ์์ฑ
๐ ์์
CTA ์ปดํฌ๋ํธ์ ๊ฐ๋ฐ์ ๊ฐ์ด๋ ๋ฌธ์๋ฅผ /docs/cta.md ํ์ผ๋ก ์์ฑํด์ฃผ์ธ์.
(์์ ํ์ ํฌํจ ๋ด์ฉ๊ณผ ๊ฐ์ด๋๋ผ์ธ ๋์ผ)
๐ฏ ๋ฌธ์ ํ์ง ๊ธฐ์ค
- ๊ฐ๋ฐ์๊ฐ ์ฆ์ ์ฌ์ฉ ๊ฐ๋ฅํ ์ค์ฉ์ ์ ๋ณด ์ ๊ณต
- ๋ชจ๋ API๊ฐ ์ ํํ๊ณ ์์ ํ๊ฒ ๋ฌธ์ํ๋จ
- ์ค์ ๋์ํ๋ ์ฝ๋ ์์ ํฌํจ
- ์ ๊ทผ์ฑ๊ณผ ์ฌ์ฉ์ฑ ๊ฐ์ด๋ ํฌํจ
- ๋ช ํํ ๊ถ์ฅ์ฌํญ๊ณผ ์ฃผ์์ฌํญ ์ ์
- ์ผ๊ด๋ ๋งํฌ๋ค์ด ์คํ์ผ๊ณผ ๊ตฌ์กฐ ์ ์ง