AI 코딩 어시스턴트와 완벽하게 작동하는 문서화 도구

# 1단계: 마켓플레이스 추가 (최초 설정)
/plugin marketplace add alonw0/llm-docs-optimizer
# 2단계: 플러그인 설치
...

cd scripts
python analyze_docs.py /path/to/your/project

# MyProject
A cool library for data processing.
## Installation
...

# MyProject
A Python library for efficient data transformation and processing pipelines.
## Quick Start
...
```bash
pip install myproject

from myproject import DataProcessor
# Load and process data
processor = DataProcessor()
result = processor.transform(data)
print(result)

from myproject import DataProcessor, ProcessingError
try:
processor = DataProcessor()
result = processor.transform(data)
except ProcessingError as e:
print(f

## 핵심 최적화 패턴
1. **질문 기반 헤더**: '설치(Installation)'를 'X는 어떻게 설치하나요?(How do I install X?)'로 변경
2. **완전한 코드 예제**: 스니펫에 임포트, 설정 및 컨텍스트 추가
3. **오류 처리**: 일반적인 오류 시나리오와 해결책 제시
4. **점진적 복잡성**: 간단하게 시작하여 고급 사용법 제시
5. **노이즈 제거**: 타임스탬프, 배지, 메타데이터 삭제
6. **구체적인 예제**: 추상적인 설명 대신 작동하는 코드 대체
## 작동 방식
### C7Score 최적화 워크플로우
이 스킬은 구조화된 워크플로우를 따릅니다:
1. **분석 단계(Analysis Phase)**
- 기존 문서를 읽습니다.
- 자동 품질 검사를 실행합니다.
- 개발자의 질문을 식별합니다.
- 콘텐츠를 질문에 매핑합니다.
2. **최적화 단계(Optimization Phase)**
- 질문을 중심으로 콘텐츠를 재구성합니다.
- 코드 스니펫에 컨텍스트를 강화합니다.
- LLM 친화적인 포맷팅을 개선합니다.
- 누락된 예제를 추가합니다.
3. **검토 단계(Review Phase)**
- 최적화된 문서를 생성합니다.
- 품질 점수 추정치를 제공합니다.
- 추가 개선 사항을 제안합니다.
### llms.txt 생성 워크플로우
이 스킬은 다음을 분석하고 생성합니다:
1. **프로젝트 분석(Project Analysis)**
- 문서 구조를 탐색합니다.
- 프로젝트 유형을 식별합니다.
- 사용 가능한 리소스를 목록화합니다.
2. **템플릿 선택(Template Selection)**
- 적절한 형식(라이브러리, CLI, 프레임워크, 스킬 등)을 선택합니다.
- 섹션 구성을 결정합니다.
- 콘텐츠 계층 구조를 계획합니다.
3.

**파일 생성 (File Generation)**
- 적절하게 형식화된 llms.txt를 생성합니다.
- 컨텍스트가 포함된 설명적 링크를 포함합니다.
- 공식 llmstxt.org 사양을 따릅니다.
- 리포지토리 루트에 저장됩니다.
## 참고 자료 (Reference Materials)
이 스킬에는 다음 내용이 포함되어 있습니다:
### C7Score 자료
- **c7score_metrics.md**: 벤치마크 메트릭에 대한 상세 설명
- **optimization_patterns.md**: 예시가 포함된 20가지 이상의 변환 패턴
- **sample_readme.md**: 최적화 전/후 예시
### llms.txt 자료
- **llmstxt_format.md**: 완전한 llms.txt 사양 및 가이드라인
- **sample_llmstxt.md**: 다양한 프로젝트 유형(라이브러리, CLI, 프레임워크, 스킬)에 대한 예시
### 도구 (Tools)
- **analyze_docs.py**: 문서화 품질 검사를 위한 자동화된 Python 스크립트
## 기여 (Contributing)
기여를 환영합니다! 개선할 영역:
- 추가적인 최적화 패턴
- 더 많은 문서 형식 지원
- c7score API 통합 (사용 가능한 경우)
- 다국어 문서 지원
- 자동 테스트 예시
- 다양한 프로젝트 유형을 위한 더 많은 llms.txt 템플릿
- 향상된 프로젝트 유형 감지 능력
## 최고의 결과를 위한 팁 (Tips for Best Results)
### C7Score 최적화의 경우
1. **README부터 시작하세요**: 일반적으로 가장 중요한 문서입니다.
2. **시작하기에 초점을 맞추세요**: 설치 및 빠른 시작 섹션이 가장 중요합니다.
3. **새 사용자처럼 생각하세요**: 그들이 어떤 질문을 할까요?
4. **AI 도구로 테스트하세요**: 개선 사항을 확인하기 위해 Claude Code 또는 다른 AI 어시스턴트를 사용하세요.
5. **반복하세요 (Iterate)**: 프로젝트가 발전함에 따라 스킬을 여러 번 실행하세요.
### llms.txt 파일의 경우
1. **업데이트 상태를 유지하세요**: 주요 문서를 추가할 때 재생성하세요.
2. **설명적 링크를 사용하세요**: 콜론(:) 뒤에 도움이 되는 메모를 추가하여 각 리소스를 설명하세요.
3. **콘텐츠 우선순위를 정하세요**: 필수 문서가 먼저 오고, 선택적 자료는 나중에 배치하세요.
4. **LLM으로 테스트하세요**: llms.txt를 사용하여 문서를 탐색하도록 Claude Code에게 요청하세요.

**규격 준수**: llmstxt.org에서 규정 준수 여부를 확인하세요
## 버전 정보
Current 버전: 1.3.0
### 1.3.0에 새로 추가된 기능
- 📈 **자동 C7Score 평가**: 모든 5가지 지표에 걸쳐 Claude 기반 점수 측정 및 이전/이후 비교 제공
- 📊 **종합적인 채점 루브릭**: c7score_metrics.md 파일에 상세한 평가 가이드라인 포함
- 🎯 **측정 가능한 개선**: 문서화 품질 향상에 대한 명확한 수치적 피드백 제공
### 이전 버전
**v1.2.0** - 이름 변경 및 플러그인 형식
- 🎯 **llm-docs-optimizer로 이름 변경** (이전 c7score-optimizer)
- 일반적인 LLM 문서화 도구 키트로서의 포지셔닝 확대
- 더 넓은 발견 가능성 및 명확한 목적 제공
- 📦 **플러그인 형식**: 마켓플레이스 배포를 위해 Claude Code 플러그인으로 변환
- 쉬운 설치: `/plugin marketplace add owner/llm-docs-optimizer`
- `.claude-plugin/plugin.json`을 사용한 전문적인 구조 갖춤
**v1.1.0** - llms.txt 생성 기능
- ✨ **llms.txt 생성**: 프로젝트를 위한 LLM 친화적인 탐색 파일 생성
- 📋 **다중 템플릿**: 라이브러리, CLI 도구, 프레임워크, 스킬 지원
- 🎯 **스마트 분석**: 자동 프로젝트 유형 감지 기능 제공
**v1.0.0** - 초기 출시
- 📊 **C7Score 최적화**: AI 코딩 어시스턴트를 위해 문서화 변환
- 📝 **질문 중심 구조**: 개발자 질문을 중심으로 콘텐츠 구성
- 🔍 **분석 도구**: 문서 스캔용 Python 스크립트 제공
## 라이선스
MIT License - 자세한 내용은 LICENSE 파일을 참조하세요
## 링크
- [Context7 c7score 벤치마크](https://www.context7.ai/c7score)
- [llmstxt.org 공식 규격](https://llmstxt.org/)
- [Claude Code 문서](https://docs.claude.com/claude-code)
- [Claude Skills 문서](https://docs.claude.com/en/docs/agents-and-tools/agent-skills/overview)
## 지원
문제나 질문이 있을 경우:
- `/references/`에서 참고 자료 확인
- `/references/optimization_patterns.md`에서 예시 패턴 검토
- 저장소에 이슈(issue)를 개설하세요

AI 코딩 어시스턴트와 완벽하게 작동하는 문서화를 위한 도구입니다.