compound-docs은(는) 무엇을 하나요?
해결된 문제를 분류된 문서로 캡처하고 YAML 머리말을 사용하여 빠르게 조회할 수 있습니다.
개요
이 스킬은 개발자가 문제를 해결한 후 그 과정과 해결책을 구조화된 문서로 기록할 수 있도록 합니다. 각 문서는 YAML 머리말을 포함하여 메타데이터를 정의하므로, 나중에 쉽게 검색하고 참조할 수 있습니다.
사용 방법
-
문서 추가
- 해결된 문제를 설명하는 마크다운 파일을 생성합니다.
- 파일 상단에 YAML 머리말을 추가하여 메타데이터를 정의합니다.
-
YAML 머리말 구조
--- title: "문제 제목" tags: [태그1, 태그2] category: "카테고리명" date: 2024-01-01 --- -
문서 검색
grep또는 유사한 도구를 사용하여 YAML 필드나 내용을 검색할 수 있습니다.- 예:
grep -r "tags:.*배포" docs/
지원 플랫폼
- Claude Code
- Cursor
- Codex
- 기타 AI 코딩 어시스턴트
예제
---
title: "Docker 컨테이너 네트워크 오류 해결"
tags: [docker, 네트워크, 오류]
category: 인프라
date: 2024-06-15
---
## 문제
Docker 컨테이너 간 통신이 불가능했습니다.
## 해결 방법
사용자 정의 브리지 네트워크를 생성하고 컨테이너를 연결했습니다.
주의 사항
- YAML 머리말은 문서의 첫 줄에 위치해야 합니다.
- 태그는 소문자로 작성하는 것을 권장합니다.
- 카테고리는 일관된 이름을 사용하여 분류를 유지하세요.