# 이 문서 사이트 소개

## 이 사이트는 무엇인가

다운(Dawoon)은 로봇착유시스템을 만드는 회사입니다. 이 사이트는 다운이 **개발하고, 제품을 만들고, 함께 일하는 방식**을 정리한 규약 문서를 모아 둔 곳입니다.

사내 개발자뿐 아니라 협업 개발자, 외부 업체(협력사)도 같은 문서를 보고 일할 수 있게 하는 것이 목적입니다.

> 왜 — 규칙이 메신저·이메일·개인 메모에 흩어져 있으면 사람마다 다르게 기억합니다. 한곳에 두고 버전을 붙이면 "지금 기준이 무엇인가"를 바로 확인할 수 있습니다.

## 문서 분류

| 분류 | 키 | 담는 것 | 예 |
|---|---|---|---|
| 개발 규약 | `dev` | 코드·저장소·빌드에 관한 공통 규칙 | 커밋 메시지, 버전·태그, 인코딩, 로그, 보안, UI 기준 |
| 상품 제작 규약 | `product` | 제품 구성과 출시 전 확인 사항 | 제품 구성 개요, 출시 체크리스트 |
| 업무·협업 규약 | `work` | 팀 사이·업체 사이 일하는 방식 | 호칭·담당 구분, 요청서·회신서 절차, 외부 업체 협업 |
| 이용 안내 | `guide` | 이 사이트 자체에 대한 안내 | 이 문서, 연결 안내 |

각 분류 안에서는 `order` 값이 작은 문서가 먼저 나옵니다.

## 공개범위 3단계

모든 문서는 머리말(frontmatter)의 `visibility` 값으로 누가 볼 수 있는지가 정해집니다.

| 값 | 이름 | 볼 수 있는 사람 | 담는 내용 |
|---|---|---|---|
| `public` | 공개 | 누구나 | 일반적인 개발 관행(커밋·버전·인코딩·UI 기준 등) |
| `partner` | 협력 | 협업·외부 업체용 접근 키를 받은 사람 | 로봇팀·외부 업체와의 협업 절차, 프로토콜 계약 절차, 도메인 용어 |
| `internal` | 사내 | 사내 전용 키 보유자 | 사내에서만 필요한 내용 |

- 공개범위는 **넓은 쪽이 좁은 쪽을 포함**합니다. `partner` 키로는 `public` + `partner` 문서를, `internal` 키로는 세 단계 모두를 볼 수 있습니다.
- 비밀번호·토큰·서버 주소(IP)·접속 별칭·개인 연락처·고객(목장) 이름은 **어느 단계의 문서에도 쓰지 않습니다.** 공개범위는 "누가 읽어도 되는가"를 나눌 뿐, 비밀을 보관하는 장소가 아닙니다.

## 문서 머리말 형식

```yaml
---
title: 커밋 메시지 규약
category: dev
visibility: public
version: 1.0.0
updated: 2026-10-27
owner: 서버개발팀
tags: [git, commit]
summary: 한 줄 요약
order: 10
---
```

| 키 | 뜻 |
|---|---|
| `title` | 문서 제목 (본문에는 `#` 제목을 따로 쓰지 않는다) |
| `category` | `dev` / `product` / `work` / `guide` |
| `visibility` | `public` / `partner` / `internal` |
| `version` | 문서 버전. 규칙의 의미가 바뀌면 올린다 (버전 규칙은 '버전·태그·릴리스 규약' 문서 참조) |
| `updated` | 마지막 수정일 (YYYY-MM-DD) |
| `owner` | 문서 책임 팀 |
| `tags` | 검색용 태그 |
| `summary` | 목록·검색 결과에 보이는 한 줄 요약 |
| `order` | 분류 안 정렬 순서 |

## 조회 방법

이 문서들은 웹 화면 외에도 다음 방법으로 읽을 수 있습니다.

- **REST API** — 프로그램에서 문서 목록·본문을 받아 갈 때
- **Swagger** — REST API 를 브라우저에서 직접 시험할 때
- **MCP** — AI 코딩 에이전트(Claude Code 등)가 규약을 직접 찾아 읽게 할 때

자세한 연결 방법은 [연결 안내](/docs/guide/connect) 문서를 참조하세요.

## 문서가 현실과 다를 때

문서와 실제 작업 방식이 다르면, 임의로 한쪽에 맞추지 말고 문서 책임 팀(`owner`)에 알려 주세요. 규칙이 바뀌면 문서의 `version` 과 `updated` 가 함께 바뀝니다.