문서 사용법

구성

머리글의 탭은 제품입니다. 시작하기, SECS/GEM, Modbus, MQTT, OPC UA, 도구 순서입니다. 탭을 고르면 왼쪽 사이드바에 그 제품의 페이지가 나옵니다. 모든 제품은 같은 순서로 구성합니다.

섹션	내용
배경 지식	표준에 근거한 개념입니다. 표준 문서와 절을 함께 적습니다.
빠른 시작	몇 분 안에 첫 통신을 확인합니다.
튜토리얼	목표, 준비물, 단계별 명령과 예상 결과, 자주 나는 오류, 정리 순서로 따라 하는 실습입니다. 맨 위의 먼저 읽어 보세요 상자는 필요한 배경 지식 페이지입니다.
가이드	시뮬레이터 GUI, 헤드리스 실행, MCP, 설정 같은 작업별 설명입니다.
API 레퍼런스	C, C++, .NET API입니다. 소스 코드의 주석에서 자동으로 만듭니다.
문제 해결	오류 메시지와 상태 코드별 원인과 해결 방법입니다.

오른쪽의 목차로 페이지 안의 절로 이동합니다. 코드 예제의 제목은 예제 폴더의 실제 파일 이름입니다. 예제 파일을 그대로 보여 주므로 받은 예제와 같습니다.

GUI의 메뉴, 버튼, 필드 이름은 화면과 같은 영어로 굵게 적습니다(예: Start lab). 명령, 파일 이름, 함수 이름은 코드 형식으로 적습니다.

언어 전환

머리글의 언어 선택에서 한국어와 English를 고릅니다. 보고 있는 페이지의 다른 언어 판으로 바로 이동합니다. 공개 사이트의 주소는 한국어가 https://pdcomm.podosoft.io/docs/…, 영어가 https://pdcomm.podosoft.io/docs/en/…이며 나머지 경로는 같습니다. 오프라인 사본에서는 앞의 /docs가 빠집니다.

API 레퍼런스의 설명은 소스 코드의 영어 주석이 원문입니다. 한국어 번역이 최신 원문과 맞지 않으면 영어 원문과 번역 갱신 대기 표시가 나옵니다.

검색

머리글의 검색 상자를 누르거나 Ctrl+K(macOS는 Cmd+K)를 누릅니다. 지금 보고 있는 언어의 문서와 API 레퍼런스를 검색합니다. 함수 이름이나 오류 메시지를 그대로 입력해도 찾을 수 있습니다.

API 레퍼런스와 변경 내역

각 제품의 API 레퍼런스에서 C, C++, .NET 중 하나를 고릅니다. 심볼 페이지에는 시그니처, 설명, 매개변수, 반환값, 선언 위치가 있습니다. 공개 API에 추가, 변경, 제거된 항목은 API 변경 내역에 정리합니다.

오프라인으로 읽기

인터넷이 없는 현장에서는 오프라인 문서 묶음(ZIP)을 씁니다. 묶음은 다음과 같이 구성됩니다.

pdcomm-docs/
├── START-HERE.ko.txt, START-HERE.en.txt   여는 방법
├── bin/pdcomm-docs                        문서 CLI (Windows는 pdcomm-docs.exe)
├── site/                                  문서 사이트 전체
├── THIRD-PARTY-NOTICES.txt                사이트에 포함된 제3자 소프트웨어 고지
└── manifest.json                          파일 목록과 SHA-256

검색은 웹 서버로 열어야 동작합니다. HTML 파일을 브라우저로 직접 열면 검색 색인을 읽지 못합니다. 다음 두 방법 중 하나를 씁니다.

pdcomm-docs로 엽니다. 압축을 푼 pdcomm-docs 폴더에서 실행합니다.
터미널 창
```
bin/pdcomm-docs serve --open
```
Windows에서는 bin\pdcomm-docs.exe serve --open을 실행합니다. 기본 주소는 http://127.0.0.1:8787/입니다. 포트를 바꾸려면 --port를 지정합니다.
또는 Python 3으로 엽니다.
터미널 창
```
python3 -m http.server 8000 --bind 127.0.0.1 --directory site
```
Windows에서는 python3 대신 py를 씁니다. 브라우저에서 http://127.0.0.1:8000/을 엽니다.

두 방법 모두 Ctrl+C로 끝냅니다. 서버는 이 컴퓨터(127.0.0.1)에서만 접속할 수 있습니다.

AI 도구에서 쓰기

pdcomm-docs는 문서 검색 CLI이자 MCP 서버입니다. Claude Code, Cursor 같은 AI 도구에 연결하면 AI가 이 문서와 API 레퍼런스를 근거로 답합니다. AI 도구에서 PDComm 문서 사용하기를 참고합니다.
사이트에는 LLM용 텍스트 파일이 있습니다. 공개 사이트에서 한국어는 /docs/llms.txt와 /docs/llms-full.txt, 영어는 /docs/en/llms.txt와 /docs/en/llms-full.txt입니다. 각 페이지의 Markdown 원문은 페이지 주소 끝에 .md를 붙인 경로에 있습니다(예: /docs/modbus/quickstart.md). 오프라인 사본에서는 앞의 /docs가 빠집니다.