Community라이팅 & 에디팅github.com

tomgoeck/project-docs-skill

Claude Code 스킬: 프로젝트 문서를 project-docs/index.html에 단일 페이지로 유지하며, Claude가 자동으로 읽고 정밀하게 업데이트합니다.

project-docs-skill란 무엇인가요?

이 스킬은 Claude Code가 프로젝트 문서를 '살아있는' 단일 HTML 페이지(project-docs/index.html)로 관리할 수 있게 해줍니다. 개발자는 별도의 문서 작성 도구 없이도 Claude와의 대화 중에 문서를 자동으로 읽고, 수정하고, 최신 상태로 유지할 수 있습니다. Claude는 기존 문서를 읽어 프로젝트 컨텍스트를 이해하고, 새로운 기능이나 변경사항이 생기면 문서의 해당 부분만 정밀하게 업데이트합니다. 이를 통해 문서와 코드가 항상 동기화되어 유지보수 부담이 크게 줄어듭니다. 주로 Claude Code 환경에서 사용되며, 별도의 플러그인이나 복잡한 설정 없이 프로젝트 디렉토리 내 파일 기반으로 동작합니다.

지원 대상✓Claude Code~Codex CLI~Cursor
npx skills add tomgoeck/project-docs-skill

Installed? Explore more 라이팅 & 에디팅 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

즐겨 사용하는 AI에게 물어보기

이 에이전트 스킬이 미리 로드된 새 채팅을 엽니다.

문서

project-docs-skill은(는) 무엇을 하나요?

Claude Code 스킬: 프로젝트 문서를 project-docs/index.html에 단일 페이지로 유지하며, Claude가 자동으로 읽고 정밀하게 업데이트합니다.

개요

이 스킬은 Claude Code가 프로젝트 문서를 지속적으로 관리할 수 있도록 합니다. 문서는 project-docs/index.html 파일에 단일 페이지로 저장되며, Claude가 작업 중 자동으로 읽고 필요에 따라 해당 부분만 업데이트합니다.

주요 기능

  • 자동 문서 읽기: Claude가 프로젝트 작업을 시작할 때 project-docs/index.html을 자동으로 읽어 프로젝트 상태와 구조를 파악합니다.
  • 정밀 업데이트: 코드 변경이나 새로운 기능 추가 시 문서의 관련 부분만 정확히 업데이트하여 불필요한 수정을 방지합니다.
  • 단일 파일 구조: 모든 문서가 하나의 HTML 파일에 있어 관리가 간편하며, 별도의 도구나 서버가 필요 없습니다.

사용 방법

  1. 프로젝트 루트에 project-docs/ 디렉토리를 생성합니다.
  2. index.html 파일을 생성하거나 Claude가 자동 생성하도록 합니다.
  3. Claude에게 문서 업데이트를 요청하면 자동으로 처리됩니다.

예제

# 프로젝트 디렉토리 구조 예시
my-project/
├── project-docs/
│   └── index.html
├── src/
├── tests/
└── README.md

지원 환경

  • 플랫폼: Claude Code
  • 의존성: 없음 (파일 기반)

주의사항

  • project-docs/index.html 파일이 없으면 Claude가 자동 생성합니다.
  • 문서 형식은 HTML을 사용하지만, 마크다운 스타일의 내용도 포함할 수 있습니다.
  • Claude가 문서를 업데이트할 때 기존 내용을 존중하며 덮어쓰기보다는 수정합니다.

관련 스킬