문서 자동화
GitHub 소스, 문서 종류, 갱신 방식을 선택해 코드 기반 문서 프로젝트를 만듭니다.
문서 프로젝트는 워크스페이스의 폴더에 GitHub 저장소를 연결해, 에이전트가 코드 기반 문서를 생성하고 동기화 상태를 유지하게 하는 단위입니다.
시작하기 전에
- 워크스페이스에 GitHub가 연결되어 있어야 합니다.
- 편집자, 관리자 또는 소유자 권한이 필요합니다. 뷰어 권한으로는 문서 프로젝트를 만들 수 없습니다.
- 문서 프로젝트는 프로·맥스·팀·엔터프라이즈 플랜에서 사용할 수 있습니다. 무료 플랜이라면 요금제를 확인하세요.
프로젝트 만들기
사이드바의 신규(+) → 프로젝트 만들기를 누르면 문서 프로젝트 설정 탭이 열립니다. 마법사는 소스와 문서 두 단계로 진행되며, 생성을 시작하기 전에 GitHub 소스, 문서 종류, 갱신 방식을 정합니다.
소스 — 어떤 코드베이스를 문서화할까요?
GitHub 계정, 저장소, 브랜치를 선택합니다. 저장소는 이름으로 검색할 수 있습니다. 저장소와 브랜치를 모두 선택하면 오른쪽 위 다음이 활성화됩니다.
문서 — 무엇을 먼저 만들까요?
에이전트가 먼저 만들 문서 스킬을 하나 이상 선택합니다. 설치된 문서 스킬이 없다면 마켓플레이스에서 찾기나 새로 만들기를 사용합니다. 스킬마다 실행 지침 보기로 어떤 문서를 어떻게 쓰는지 확인할 수 있습니다.
강조할 점 — 선택 사항
같은 단계의 **이번 생성에서 강조할 점 (선택)**에 이번 생성에만 적용할 요청을 적습니다. 문서를 읽을 대상, 강조할 내용, 원하는 상세 수준을 구체적으로 쓸수록 결과가 좋아집니다.
갱신 방식 — 코드가 바뀌면 어떻게 할까요?
저장소 변경을 자동으로 반영을 켜면 선택한 브랜치에 코드가 반영될 때 문서를 최신 상태로 업데이트합니다. 준비가 끝나면 문서 N종 만들기를 눌러 생성을 시작합니다.
선택한 문서 중 일부가 전체 재생성 방식이면, 코드 변경 시 증분 갱신 문서만 자동으로 갱신됩니다. 전체 재생성 문서는 수동으로 다시 생성해야 합니다.
생성 중에 일어나는 일
생성을 시작하면 Specify는 다음을 준비합니다.
- 프로젝트 색인 — 폴더, 프로젝트 레코드, 생성 작업을 연결해 이후 업데이트가 같은 프로젝트에 붙도록 합니다.
- 자동 최신화 준비 — 생성된 문서가 변경 제안을 받을 수 있도록 선택한 자동화 모드를 먼저 저장합니다.
- 변경 검토 기반 — 생성된 페이지에 소스 링크를 남겨 이후 저장소 변경을 근거와 함께 검토할 수 있게 합니다.
생성 화면을 닫아도 인박스가 작업을 계속 추적합니다. 문서별 생성 상태는 시작 대기, 작성 중, 완료, 실패, 시작 차단으로 표시됩니다.
에이전트가 질문할 때
문서를 쓰는 데 필요한 정보가 부족하면 에이전트가 질문하고 답을 기다립니다. 스레드를 열어 답하면 생성이 이어집니다.
생성이 완료되지 않았을 때
프로젝트는 만들어졌지만 첫 문서 생성이 완료되지 않으면 생성 확인이 필요합니다가 표시됩니다. 표시된 사유를 확인한 뒤 다음 중 하나를 선택합니다.
- 다시 시도 — 같은 설정으로 생성을 다시 시작합니다.
- 소스 변경 — 저장소나 브랜치를 바꿔 다시 시작합니다.
- 닫고 알림 받기 — 인박스에서 결과를 이어서 확인합니다.
작업 한도에 도달해 일부 문서 작업이 시작되지 않았다면, 예산과 프로젝트 권한을 확인하고 실행 중인 문서 작업이 끝난 뒤 다시 생성하세요.
문서 추가하기
첫 실행 후 같은 프로젝트 폴더에 다른 가이드나 레퍼런스를 추가로 생성할 수 있습니다. 프로젝트 목록에서 프로젝트를 선택하고 문서 추가를 실행합니다.