Codex use case
문서를 최신 상태로 유지하기
코드와 참고 자료를 활용해 문서 업데이트를 자동화하세요.
Codex로 소스 코드 변경 사항, 공개 문서, 릴리스 노트, PR의 배경 정보를 대조하세요. 이를 바탕으로 수정이 필요한 부분만 골라 문서 수정안을 작성하고, 게시 전에 무엇을 어떻게 검증할지 정리하세요.
Best for
- 자주 바뀌는 제품 동작을 반영해야 하는 개발자 문서, README, 런북, 예제, 마이그레이션 노트
- 기술 제품의 문서를 관리하는 팀
Contents
문서를 최신 상태로 유지하기
코드와 참고 자료를 활용해 문서 업데이트를 자동화하세요.
Codex로 소스 코드 변경 사항, 공개 문서, 릴리스 노트, PR의 배경 정보를 대조하세요. 이를 바탕으로 수정이 필요한 부분만 골라 문서 수정안을 작성하고, 게시 전에 무엇을 어떻게 검증할지 정리하세요.
Codex로 소스 코드 변경 사항, 공개 문서, 릴리스 노트, PR의 배경 정보를 대조하세요. 이를 바탕으로 수정이 필요한 부분만 골라 문서 수정안을 작성하고, 게시 전에 무엇을 어떻게 검증할지 정리하세요.
Related links
Best for
- 자주 바뀌는 제품 동작을 반영해야 하는 개발자 문서, README, 런북, 예제, 마이그레이션 노트
- 기술 제품의 문서를 관리하는 팀
Skills & Plugins
- GitHub로 버그 제보를 받을 때 이슈, Pull Request, 댓글, 리뷰 스레드, 실패한 검사 결과를 확인하세요.
| Skill | Why use it |
|---|---|
| GitHub | GitHub로 버그 제보를 받을 때 이슈, Pull Request, 댓글, 리뷰 스레드, 실패한 검사 결과를 확인하세요. |
Starter prompt
소개
문서를 최신 상태로 유지하는 가장 쉬운 방법은 소스 코드를 변경할 때 문서도 함께 업데이트하는 것입니다. 몇 주씩 미루면 변경 사항을 반영하기가 더 어렵습니다. Codex는 변경된 코드와 테스트, 릴리스 노트, 연결된 이슈, pull request의 컨텍스트를 살펴본 뒤 기존 문서 구조에 맞춰 수정이 필요한 부분의 초안을 작성할 수 있습니다.
개발자 문서나 README를 업데이트하거나 변경 로그 초안, 마이그레이션 안내, 런북 등 자주 바뀌는 동작을 반영해야 하는 문서를 작성할 때 이 워크플로우를 사용하세요.
사용 방법
-
문서에 반영할 변경 사항을 알려 주세요.
관련 브랜치, pull request, 커밋, 이슈 또는 파일을 공유하세요. 공개 문서라면 미공개 로드맵, 고객의 비공개 정보, 내부에서만 공유하는 컨텍스트는 제외하라고 명시하세요.
-
Codex에 변경 사항을 반영해야 할 문서를 찾아 달라고 요청하세요.
초안을 작성하기 전에 기존 문서에서 기능 이름, 설정 키, 명령어, 예시, 관련 용어를 검색하도록 하세요.
-
변경 사항을 설명하는 데 필요한 부분만 업데이트하세요.
Codex가 기존 페이지 구조, 용어, 문서 간 링크, 프런트매터를 유지하도록 하세요. 정확한 설명이나 예시를 추가하거나 특정 섹션을 수정하는 것만으로 충분하다면 문서를 대대적으로 다시 쓰지 않도록 하세요.
-
변경 사항을 검증하세요.
Codex에 레포지토리에 맞는 서식 검사와 문서 검사를 실행한 뒤, 사용자에게 안내하는 각 내용의 근거를 요약해 달라고 요청하세요.
Codex에 제공할 자료
| 자료 | 활용 방법 |
|---|---|
| 변경된 코드와 테스트 | Codex가 실제 동작을 분석해 변경 사항에 초점을 맞춘 문서 수정안을 작성할 수 있습니다. |
| 공개 릴리스 노트 또는 제품 문서 | Codex가 공개 자료에 쓰인 용어를 따르고 기능의 제공 범위와 현재 상태를 정확히 반영할 수 있습니다. |
| Pull request 또는 이슈의 컨텍스트 | 변경 이유와 사용자가 알아야 할 동작을 파악할 수 있습니다. |
| 로컬 문서 검사 | 문서를 게시하기 전에 충족해야 할 구체적인 완료 기준을 Codex에 제시할 수 있습니다. |
공개 릴리스 노트 등 참고 자료를 더 제공하면 Codex가 비공개 컨텍스트나 아직 공개되지 않은 변경 사항을 문서에 포함하는 일을 피할 수 있습니다.
워크플로우 재사용하기
레포지토리 전체에서 같은 문서 작성 기준을 따르도록 AGENTS.md에 다음과 같이 지침을 추가하세요.
## Documentation
- When user-facing behavior changes, check whether docs, examples, or changelogs need updates.
- Public docs must only include public information or behavior visible in this repo.
- Preserve existing terminology and frontmatter.
- Run the docs formatting and build checks before final handoff.절차에 단계가 더 많다면 스킬로 만들어 두세요. 이후 Codex 작업에서도 같은 절차에 따라 자료를 확인하고 초안을 작성한 뒤 검증할 수 있습니다. 자세한 내용은 워크플로우를 스킬로 저장하기를 참고하세요.
현재 채팅에서 이 워크플로우를 예약 작업으로 설정할 수도 있습니다. 예를 들어 Codex에 매주 GitHub에서 최근 pull requests를 가져와 문서를 업데이트해 달라고 요청하세요.
Related use cases
Codex가 사용할 CLI 만들기
Codex에 어느 폴더에서나 실행할 수 있고 레포지토리 스크립트와 조합하거나 파일을 다운로드할 때 쓸 수 있는 CLI를 만들어 달라고 하세요
검증 모듈 마이그레이션
Codex에 마이그레이션 범위를 명시한 문서와 계약 테스트 픽스처, 미리 설정한 클라우드 환경을 제공하세요
목표를 향해 작업하기
Codex가 여러 대화 턴에 걸쳐 작업을 이어가야 하고 종료 조건의 충족 여부를 확인할 수 있다면 `/goal`을 사용하세요.