한줄평
“모듈 문서를 코드와 항상 일치시키고 싶을 때 사실상 표준처럼 쓰입니다. 다만 문서 내용의 서술 부분까지 채워 주진 않아, 설명 문장은 여전히 사람이 써야 합니다.”
이런 분께 테라폼 모듈 README 를 자동으로 최신 상태로 유지하려는 분께
좋은 점
- 모듈 변수·출력 문서를 자동 생성
- 마크다운·JSON 등 다양한 출력 형식
아쉬운 점
- 표 구조만 만들 뿐 설명 문장은 직접 작성해야 함
테라폼 독스 소개
테라폼(Terraform) 모듈의 변수·출력·요구사항을 읽어 문서를 자동으로 뽑아 주는 명령줄 도구입니다. 모듈 디렉터리를 가리키면 입력 변수와 출력값 표를 만들어 마크다운·JSON·표 등 원하는 형식으로 내보냅니다. README 를 손으로 갱신하지 않아도 되도록 CI 파이프라인이나 pre-commit 훅에 걸어 두고 씁니다.
