Skip to content

Commit 19de17a

Browse files
committed
docs: prepare public release
1 parent 6a4a236 commit 19de17a

4 files changed

Lines changed: 204 additions & 33 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,23 @@
2323
- 화면 문구는 짧게 쓴다. 기능 설명보다 결과와 조작을 바로 보여준다.
2424
- 사이트명은 `리버스 맞춤법 검사기`, 화면 타이틀은 `맏춤법 검사기`를 유지한다.
2525
- 결과 영역에서는 바뀐 표현을 문장 안에서 직접 밑줄/하이라이트로 보여준다.
26+
- `제보`, `피드백`, `오류 신고`처럼 부담이 큰 말보다 사용자가 가볍게 누를 수 있는 말을 우선한다. 예: `이것도 넣어줘`, `기록해두기`.
27+
- 팝업 문구는 사용자가 무엇을 적으면 되는지 바로 알 수 있게 쓰고, 데이터 저장 범위는 숨기지 않는다.
28+
29+
## SEO와 검색 노출
30+
31+
- 대표 URL은 `https://reverse-spell-checker.vercel.app/`다. 커스텀 도메인은 별도 요청 전까지 붙이지 않는다.
32+
- `robots.txt``sitemap.xml` 하나만 가리킨다. `sitemap.txt` 같은 대체 파일을 다시 추가하지 않는다.
33+
- Google 일반 웹페이지는 Indexing API 대상이 아니다. 검색 노출 관련 작업은 Search Console URL 검사, sitemap 제출, 외부 링크, 정적 HTML 본문 보강으로 처리한다.
34+
- SEO용 정적 본문은 `client/index.html``#root` fallback 안에 둔다. React 렌더링 전에도 `맏춤법 검사기`, `리버스 맞춤법 검사기`, 주요 케이스가 읽혀야 한다.
35+
- 메타/구조화 데이터/README/레포 description이 서로 다른 이름을 말하지 않게 유지한다.
36+
37+
## 맞춤법 룰 운영
38+
39+
- 새 룰은 `RULE_UPDATE.md``docs/spelling-rules.md` 기준을 따른다.
40+
- 룰 추가 시 `client/src/lib/reverseSpellCheck.ts``client/src/lib/reverseSpellCheck.fixtures.ts`를 함께 수정한다.
41+
- 문맥 없이 정상 문장을 과하게 바꾸는 룰은 기본 룰로 넣지 않는다.
42+
- 사용자 입력 원문 저장은 별도 동의와 정책 없이는 하지 않는다. GA4에는 분류, 길이, rule id 같은 비식별 신호만 보낸다.
2643

2744
## UI 구현 원칙
2845

@@ -42,6 +59,7 @@
4259
- 기존 사용자 변경을 되돌리지 않는다.
4360
- 새 기능보다 현재 사용자 경험을 유지하는 작은 수정이 우선이다.
4461
- 불필요한 리팩터링, 문서 대량 생성, 디자인 전면 교체는 요청이 있을 때만 한다.
62+
- 커밋/푸시는 사용자가 명시했을 때만 한다. 단, 사용자가 릴리즈/배포/푸시까지 요청한 경우에는 작업별 커밋 후 push한다.
4563

4664
## 검증
4765

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Changelog
2+
3+
## v1.0.0 - 2026-05-16
4+
5+
첫 공개 릴리즈입니다.
6+
7+
### Product
8+
9+
- `맏춤법 검사기` 메인 화면을 제공합니다.
10+
- 되/돼, 안/않, 왜/외, 며칠/몇일 등 자주 헷갈리는 한국어 표현을 문장 안에서 표시합니다.
11+
- 맞춤법, 띄어쓰기, 표준어, 외래어 분류를 지원합니다.
12+
- 결과 복사, 공유, 이미지 저장을 지원합니다.
13+
- 빠진 표현을 남길 수 있는 팝업을 제공합니다. 현재 GA4에는 원문 대신 분류와 길이만 기록합니다.
14+
15+
### Operations
16+
17+
- Vercel Git 연동 배포를 설정했습니다.
18+
- Google Search Console, Naver Search Advisor 검증 파일과 SEO 메타를 추가했습니다.
19+
- `robots.txt``sitemap.xml`을 정리했습니다.
20+
- GA4 기본 이벤트와 룰 매칭 이벤트를 추가했습니다.
21+
22+
### Documentation
23+
24+
- README, AGENTS, CLAUDE, 맞춤법 룰 문서를 정리했습니다.
25+
- 룰 업데이트 기준과 현재 적용된 규칙 목록을 문서화했습니다.

CLAUDE.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# CLAUDE.md
2+
3+
이 파일은 Claude Code와 다른 코드 에이전트가 이 저장소에서 작업할 때 참고하는 운영 메모다. 실제 우선순위는 사용자 지시, 더 가까운 `AGENTS.md`, 이 파일 순서다.
4+
5+
## Project Snapshot
6+
7+
- 제품: `맏춤법 검사기`
8+
- 성격: 올바른 한국어 문장을 자주 헷갈리는 표기로 바꿔 보여주는 리버스 맞춤법 검사기
9+
- 대표 URL: https://reverse-spell-checker.vercel.app/
10+
- 저장소: https://github.com/makersfarm/reverse-spell-checker
11+
- 배포: Vercel Git 연동, `main` push 시 Production 배포
12+
13+
## Stack
14+
15+
- React 19
16+
- Vite
17+
- TypeScript
18+
- Express 정적 서버
19+
- Vitest
20+
- GA4
21+
- pnpm
22+
23+
## Commands
24+
25+
```bash
26+
pnpm install
27+
pnpm dev
28+
pnpm check
29+
pnpm test
30+
pnpm build
31+
pnpm qa
32+
```
33+
34+
## Important Paths
35+
36+
- `client/src/pages/Home.tsx`: 메인 UI
37+
- `client/src/index.css`: 화면 스타일
38+
- `client/index.html`: SEO 메타, 정적 fallback 본문
39+
- `client/src/lib/reverseSpellCheck.ts`: 변환 룰
40+
- `client/src/lib/reverseSpellCheck.fixtures.ts`: 테스트 fixture
41+
- `client/src/lib/analytics.ts`: GA4 이벤트
42+
- `docs/spelling-rules.md`: 현재 적용된 맞춤법 규칙
43+
- `RULE_UPDATE.md`: 룰 추가 기준
44+
- `DEPLOYMENT.md`: 배포 운영
45+
46+
## Product Rules
47+
48+
- 사이트명은 `리버스 맞춤법 검사기`, 화면 타이틀은 `맏춤법 검사기`를 유지한다.
49+
- 사용자에게 “우리가 일부러 틀리게 만든다”는 식으로 설명하지 않는다. 화면 분위기와 예시로 이해시키는 쪽을 우선한다.
50+
- 결과는 문장 안에서 직접 밑줄/하이라이트로 보여준다.
51+
- 문장부호, 과한 띄어쓰기 장난, 사용자를 불쾌하게 만들 수 있는 변환은 넣지 않는다.
52+
- 새 맞춤법 룰은 테스트 fixture와 함께 추가한다.
53+
- 사용자 원문은 별도 동의 없이 저장하지 않는다.
54+
55+
## UX Copy
56+
57+
피해야 할 말:
58+
59+
- `오염`
60+
- `교정 결과`
61+
- `재미난 검사기`
62+
- `일부러 틀려보기`
63+
- `문장을 살짝 어긋나게`
64+
- `맞춤법을 틀리게 만들어드립니다`
65+
- `역대급 오류 보장`
66+
- `오류 공장`
67+
- `맞춤법 파괴`
68+
- `틀린 문장 제조`
69+
- `의도적으로 오류`
70+
71+
좋은 방향:
72+
73+
- 짧게 쓴다.
74+
- 설명보다 조작과 결과를 먼저 보여준다.
75+
- 버튼은 사용자가 바로 행동할 수 있는 말로 쓴다.
76+
- 데이터 저장 범위는 짧고 정확하게 밝힌다.
77+
78+
## SEO Notes
79+
80+
- 커스텀 도메인은 아직 붙이지 않는다.
81+
- `robots.txt``sitemap.xml` 하나만 가리킨다.
82+
- 일반 웹페이지는 Google Indexing API 대상이 아니다.
83+
- 검색 노출 개선은 Search Console URL 검사, sitemap 제출, 외부 링크, 정적 HTML 본문 보강으로 처리한다.
84+
- `client/index.html`의 정적 fallback 본문은 검색봇이 JS 렌더링 전에 읽는 최소 설명이므로 지우지 않는다.
85+
86+
## Skill Routing
87+
88+
When a request matches an available skill, use it.
89+
90+
- UI/UX review or visual QA: `/design-review`, `/qa`, `ui-ux-pro-max`
91+
- Release/documentation cleanup: `/document-release`
92+
- Deployment: Vercel workflow or `/setup-deploy`
93+
- Bug investigation: `/investigate`
94+
- Product/positioning questions: `/office-hours`, `/plan-ceo-review`
95+
- Architecture planning: `/plan-eng-review`
96+
97+
## Release Checklist
98+
99+
Before a release:
100+
101+
```bash
102+
pnpm qa
103+
```
104+
105+
Then:
106+
107+
1. Update docs if behavior changed.
108+
2. Commit by work unit.
109+
3. Push `main`.
110+
4. Create a GitHub release tag.
111+
5. Confirm Vercel production URL responds.

README.md

Lines changed: 50 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
11
# 맏춤법 검사기
22

3-
올바른 한국어 문장을 흔히 보이는 맞춤법/띄어쓰기 실수 형태로 바꿔 보여주는 React/Vite 앱입니다.
3+
올바른 한국어 문장을 사람들이 자주 헷갈리는 표기로 바꿔 보여주는 리버스 맞춤법 검사기입니다.
44

5-
서비스: https://reverse-spell-checker.vercel.app/
5+
- 서비스: https://reverse-spell-checker.vercel.app/
6+
- GitHub: https://github.com/makersfarm/reverse-spell-checker
67

7-
## 주요 기능
8+
## 무엇을 하나요
89

9-
- 되/돼, 안/않, 왜/외, 며칠/몇일처럼 자주 헷갈리는 한국어 표현을 문장 안에서 표시
10-
- 맞춤법, 띄어쓰기, 표준어, 외래어 분류별 결과 제공
11-
- 결과 복사, 공유, 이미지 저장
10+
- 되/돼, 안/않, 왜/외, 며칠/몇일처럼 자주 헷갈리는 표현을 문장 안에서 표시합니다.
11+
- 맞춤법, 띄어쓰기, 표준어, 외래어 분류별로 바뀐 표현을 보여줍니다.
12+
- 결과를 복사하거나 공유하고, 이미지로 저장할 수 있습니다.
13+
- 빠진 표현은 앱 안에서 가볍게 남길 수 있고, GA4에는 원문 대신 분류와 길이만 보냅니다.
1214

13-
## 구성
15+
## 프로젝트 구조
1416

15-
- `client/`: React 프론트엔드
16-
- `server/`: 프로덕션 정적 파일 서빙용 Express 서버
17-
- `shared/`: 클라이언트/서버 공유 상수
17+
```txt
18+
client/ React + Vite 프론트엔드
19+
server/ 프로덕션 정적 파일 서빙용 Express 서버
20+
shared/ 클라이언트/서버 공유 코드
21+
docs/ 맞춤법 규칙과 운영 문서
22+
```
23+
24+
핵심 파일:
25+
26+
- `client/src/pages/Home.tsx`: 메인 화면, 입력/결과/공유/표현 추가 UI
27+
- `client/src/lib/reverseSpellCheck.ts`: 리버스 맞춤법 변환 로직
28+
- `client/src/lib/reverseSpellCheck.fixtures.ts`: 룰 테스트 fixture
29+
- `client/src/lib/analytics.ts`: GA4 이벤트 전송
30+
- `docs/spelling-rules.md`: 현재 적용된 규칙 정리
31+
- `RULE_UPDATE.md`: 새 맞춤법 룰을 추가할 때의 기준
1832

1933
## 로컬 개발
2034

@@ -23,48 +37,51 @@
2337
- Node.js 20 이상
2438
- pnpm
2539

26-
의존성 설치:
27-
2840
```bash
2941
pnpm install
30-
```
31-
32-
개발 서버 실행:
33-
34-
```bash
3542
pnpm dev
3643
```
3744

38-
타입 체크:
45+
검증:
3946

4047
```bash
4148
pnpm check
42-
```
43-
44-
테스트 실행:
45-
46-
```bash
4749
pnpm test
48-
```
49-
50-
프로덕션 빌드:
51-
52-
```bash
5350
pnpm build
5451
```
5552

56-
빌드 결과 미리보기:
53+
한 번에 확인:
5754

5855
```bash
59-
pnpm preview
56+
pnpm qa
6057
```
6158

62-
## Vercel
59+
## 배포
6360

64-
이 저장소를 Vercel에 가져올 때 `reverse-spell-checker` 디렉터리를 프로젝트 루트로 지정합니다. Vercel의 Vite 프리셋 기준 설정은 다음과 같습니다.
61+
Vercel Git 연동을 사용합니다. `main` 브랜치에 push하면 Production 배포가 생성됩니다.
6562

63+
Vercel 설정:
64+
65+
- Repository: `makersfarm/reverse-spell-checker`
66+
- Framework Preset: `Vite`
6667
- Install Command: `pnpm install --frozen-lockfile`
6768
- Build Command: `pnpm build`
6869
- Output Directory: `dist/public`
70+
- Production Branch: `main`
71+
72+
자세한 내용은 [DEPLOYMENT.md](./DEPLOYMENT.md)를 봅니다.
73+
74+
## 문서
75+
76+
- [맞춤법 룰 업데이트 기준](./RULE_UPDATE.md)
77+
- [현재 적용 규칙](./docs/spelling-rules.md)
78+
- [룰 후보 정리](./RULE_CANDIDATES.md)
79+
- [기능 명세](./SPEC.md)
80+
- [배포 운영](./DEPLOYMENT.md)
81+
82+
## 운영 메모
6983

70-
현재 MVP에는 런타임 환경 변수가 필요하지 않습니다.
84+
- 사이트명은 `리버스 맞춤법 검사기`, 화면 타이틀은 `맏춤법 검사기`입니다.
85+
- 커스텀 도메인은 나중에 붙입니다. 현재 대표 URL은 Vercel 기본 도메인입니다.
86+
- sitemap은 `sitemap.xml` 하나만 사용합니다.
87+
- 일반 웹페이지는 Google Indexing API 대상이 아닙니다. 검색 노출 개선은 Search Console URL 검사, sitemap 제출, 외부 링크, 정적 본문 보강으로 처리합니다.

0 commit comments

Comments
 (0)