문서 생성 자동화 실전

지어낸 동작: 생성된 설명은 항상 실제 구현과 교차 확인하세요.
오래된 문서: 생성된 문서는 빨리 부패합니다——프롬프트를 릴리스 프로세스의 일부로 만드세요.
비공개 내부: 구현 세부가 누출되지 않도록 내부/비내보낸 기호는 명시적으로 제외합니다.

소스 코드를 유지되는 문서로 바꿉니다. OpenCode는 모듈을 읽고, 공개 API를 추출하며, 문서 사이트에 바로 넣을 수 있는 레퍼런스 문서를 작성합니다.

이 레시피를 사용하는 경우

소스 지정

문서화할 모듈과 출력 위치를 OpenCode에 알립니다.

src/services/의 모든 내보낸 함수를 문서화하세요. 각각에 대해 서명, 매개변수, 반환 타입, 한 줄 예제를 포함한 섹션을 쓰고 docs/reference/services.mdx로 출력하세요.
서식 설정

frontmatter와 구조를 지정하여 출력이 문서 시스템에 맞게 합니다.
```
---
title: Services Reference
description: API reference for the services module.
---
```
정확성 검토

OpenCode는 사실이 아닌 동작을 추론할 수 있습니다——각 설명을 코드와 대조하며 특히 엣지 케이스를 검증합니다.
빌드에 연결

생성된 페이지를 사이드바/문서 파이프라인에 추가하여 게시되게 합니다.
새로고침 예약

큰 변경 후 동일한 프롬프트를 다시 실행하여 문서를 동기화합니다.

src/services/의 모든 내보낸 기호를 읽고 Markdown 레퍼런스를 생성하세요. 각각에 서명, 매개변수 설명, 반환 타입, 구체적인 예제를 포함하세요. 동작을 지어내지 마세요——확실하지 않으면 “검토 필요”로 표시하세요.