# 다운(Dawoon) 규약 문서

> 다운 개발·상품 제작·업무 규약. MCP: https://docs.dawoon.link/mcp · REST: https://docs.dawoon.link/api/v1 · OpenAPI: https://docs.dawoon.link/api/v1/openapi.json

## 이용 안내

- [이 문서 사이트 소개](https://docs.dawoon.link/api/v1/docs/guide/about?format=markdown): 다운(Dawoon)의 개발·상품제작·업무 규약을 한곳에 모은 문서 사이트의 구성과 공개범위, 조회 방법을 안내한다.
- [연결 안내 — 웹·REST API·MCP](https://docs.dawoon.link/api/v1/docs/guide/connect?format=markdown): 접근 키 받기, 웹 로그인, REST API·Swagger 호출, AI 에이전트(MCP) 연결 방법.

## 개발 규약

- [커밋 메시지 규약](https://docs.dawoon.link/api/v1/docs/dev/commit-message?format=markdown): 「[type]: 공통 주제 - 개별 내용」 형식과, 한 작업을 여러 커밋으로 나눌 때 앞부분을 똑같이 유지하는 규칙.
- [버전·태그·릴리스 규약](https://docs.dawoon.link/api/v1/docs/dev/versioning-release?format=markdown): SemVer A.B.C 판단 기준, 프로젝트별 태그 접두 유지, 릴리스 노트·라벨 관리 규칙.
- [이슈 기반 개발 흐름](https://docs.dawoon.link/api/v1/docs/dev/issue-driven-workflow?format=markdown): 개발 전에 이슈를 등록하고, 커밋에 이슈 번호를 남기고, 검증 결과를 코멘트한 뒤 닫는 흐름.
- [브랜치 운영](https://docs.dawoon.link/api/v1/docs/dev/branching?format=markdown): develop 을 통합 브랜치로 두고 기능 브랜치에서 작업해 develop 으로 PR 하는 흐름.
- [코드 작성·변경 원칙과 모듈화](https://docs.dawoon.link/api/v1/docs/dev/code-principles?format=markdown): 가정을 밝히고 최소한으로 고치는 원칙, 파일 크기 기준(300/500줄), 수정 이력 기록 위치, 서버·클라이언트 동시 확인.
- [문자 인코딩 — UTF-8 필수](https://docs.dawoon.link/api/v1/docs/dev/encoding-utf8?format=markdown): 콘솔·파일·문서·설정·네트워크 전송 모두 UTF-8(BOM 없음). cp949 로 새지 않게 코드가 직접 막는다.
- [로그 파일 정책](https://docs.dawoon.link/api/v1/docs/dev/logging-policy?format=markdown): 날짜/카테고리 폴더 구조, 경로를 한 모듈에서만 만드는 규칙, 조사 순서대로 번호 매긴 카테고리, 보존 기간.
- [보안 기본 규칙](https://docs.dawoon.link/api/v1/docs/dev/security-basics?format=markdown): 비밀값을 이슈·커밋·로그·문서에 남기지 않기, 로그인 화면 기본 계정 노출 금지, 서명 키 보관, 새 저장소는 비공개 기본.
- [DB 작업 규칙 — 저장 프로시저 금지](https://docs.dawoon.link/api/v1/docs/dev/database-rules?format=markdown): 새로 만드는 기능은 저장 프로시저 대신 파라미터 SQL·ORM·트랜잭션을 쓴다. 기존 프로시저는 그 표를 고칠 때 점진적으로 옮긴다.
- [UI 공통 기준 — 반응형·표 정렬·제목 버전 표기](https://docs.dawoon.link/api/v1/docs/dev/ui-standards?format=markdown): 모든 화면은 모바일 반응형·넘침 0건, 모든 데이터 표는 컬럼 정렬, 프로그램 제목에 제품명·버전·빌드 시각을 표시한다.
- [.gitignore 기본](https://docs.dawoon.link/api/v1/docs/dev/gitignore-basics?format=markdown): 개발 문서 폴더(docs/, **/docs/)·비밀값·빌드 산출물을 처음부터 저장소에서 제외한다.

## 상품 제작 규약

- [제품 구성 개요](https://docs.dawoon.link/api/v1/docs/product/product-overview?format=markdown): 로봇착유시스템을 이루는 장치·소프트웨어(착유 로봇, 버퍼탱크·냉각기, 세척, 스마트게이트, 급이기, 목장 서버·대시보드)를 고객·협력사 관점에서 소개한다.
- [상품 출시 체크리스트](https://docs.dawoon.link/api/v1/docs/product/release-checklist?format=markdown): 새 버전을 내기 전에 확인할 버전·이슈·검증·화면·인코딩·보안·릴리스 노트 항목.