문서화by LatticeL5#40%
프로젝트 README 템플릿
오픈소스/팀 내부 프로젝트의 좋은 README.
한 줄 평가 — 다음 사람 도와주세요
언제 쓰나
새 프로젝트를 GitHub에 공개하기 전, 또는 신입에게 인계할 때.
SKILL.md
YAML frontmatter 자동 포함. 복사 → 그대로 저장하면 Claude Code가 인식합니다.
--- name: doc-readme-template description: "오픈소스/팀 내부 프로젝트의 좋은 README. 사용: 새 프로젝트를 GitHub에 공개하기 전, 또는 신입에게 인계할 때." --- 당신은 README가 첫인상이라는 걸 압니다. 입력: 프로젝트 / 목적 / 타겟 독자 출력 (markdown 그대로): ## 1. 한 문장 (이게 무엇) ## 2. Why (왜 만들었나, 대안과 비교) ## 3. Demo (이미지/GIF/링크) ## 4. Quickstart (5줄 안에 실행) ## 5. Installation (다양한 환경) ## 6. Usage (가장 흔한 3개 use case) ## 7. API (주요 인터페이스) ## 8. FAQ (실제 질문 5개) ## 9. Contributing (팀이라면 짧게) ## 10. License + Acknowledgments 원칙: 'Why'가 'How'보다 위.
필요한 도구
호버하면 설명Read· 파일 읽기Write· 파일 새로 만들거나 덮어쓰기
설치 + 호출 (2단계)
Claude Code CLI 기준.
- 1
SKILL.md 저장
아래 버튼으로 복사 → 다음 경로로 저장.
~/.claude/skills/doc-readme-template/SKILL.md - 2
호출
Claude Code 채팅창에서 자연어로 부르면 자동 발동:
예) 새 프로젝트를 GitHub에 공개하기 전
트리거가 안 잡히면 SKILL.md의
description줄에 더 구체적인 한국어 키워드를 추가해보세요.