documentation
기술 문서 생성
متاح أيضًا من: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
이 스킬은 API 문서, README 파일, 아키텍처 문서를 포함한 기술 문서 작성을 자동화합니다. 개발자가 수동 작업 없이 일관되고 전문적인 문서를 유지할 수 있도록 지원합니다.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "documentation". CSV 파일을 처리하는 Python CLI 도구의 README 생성
النتيجة المتوقعة:
# CSV Processor CLI
CSV 파일을 처리하고 변환하는 명령줄 도구입니다.
## 설치
```bash
pip install csv-processor
```
## 사용법
```bash
csv-processor input.csv --output output.csv --transform uppercase
```
## 기능
- CSV 파일 읽기 및 쓰기
- 변환 적용
- 조건별 행 필터링
- 여러 형식으로 내보내기
استخدام "documentation". 이 API 엔드포인트 문서화: POST /users/{id}/orders
النتيجة المتوقعة:
## 사용자 주문 생성
**엔드포인트:** `POST /users/{id}/orders`
특정 사용자의 새 주문을 생성합니다.
### 매개변수
- `id` (경로, 필수): 사용자의 고유 식별자
- `items` (본문, 필수): 주문 항목 배열
- `shipping_address` (본문, 필수): 배송 주소
### 응답
```json
{
"order_id": "ord_123",
"status": "pending",
"total": 99.99
}
```
التدقيق الأمني
مخاطر عاليةStatic analysis detected 72 potential security issues including 61 instances of shell command execution, 11 references to weak cryptographic algorithms, and 2 instances of system reconnaissance patterns. These patterns are highly unusual for a documentation skill and require manual review. The high density of external command invocations and security-related patterns suggests this skill may contain functionality beyond simple documentation generation.
مشكلات عالية المخاطر (1)
مشكلات متوسطة المخاطر (1)
مشكلات منخفضة المخاطر (1)
عوامل الخطر
⚙️ الأوامر الخارجية (61)
⚡ يحتوي على سكربتات
الأنماط المكتشفة
درجة الجودة
ماذا يمكنك بناءه
API 문서 생성
소스 코드에서 엔드포인트, 매개변수, 응답 타입을 포함한 포괄적인 API 문서를 자동으로 생성합니다.
프로젝트 README 작성
시작 가이드, 설치 방법, 기여 가이드라인을 포함한 완성도 높은 README 파일을 작성합니다.
코드 주석 개선
인라인 코드 주석과 docstring 을 추가하거나 개선하여 코드의 가독성과 유지보수성을 높입니다.
جرّب هذه الموجهات
이 프로젝트의 README.md 파일을 생성하세요. 다음 섹션을 포함하세요: 프로젝트 제목, 설명, 설치, 사용법, 기여, 라이선스.
다음 코드에 대한 API 문서를 생성하세요. 엔드포인트 설명, 매개변수 세부정보, 요청/응답 예시, 에러 코드를 포함하세요.
이 코드베이스에 대한 시스템 개요, 컴포넌트 다이어그램 설명, 데이터 흐름, 설계 결정을 포함한 아키텍처 문서를 작성하세요.
다음 코드에 포괄적인 인라인 주석과 docstring 을 추가하세요. 복잡한 로직을 설명하고, 매개변수와 반환값을 문서화하며, 파일에 헤더 주석을 추가하세요.
أفضل الممارسات
- 원하는 문서 형식과 구조에 대해 명확하고 구체적인 지침을 제공하세요
- 업데이트를 요청할 때 기존 문서나 코드 컨텍스트를 포함하세요
- 게시 전에 생성된 문서의 기술적 정확성을 검토하세요
- 문서 전체에 일관된 형식과 스타일 가이드라인을 사용하세요
تجنب
- 소스 코드나 컨텍스트 없이 문서화를 요청하기
- 실행 없이 스킬이 런타임 동작을 이해할 것으로 기대하기
- 수동 기술 검토 없이 생성된 문서에만 의존하기
- 주석이나 구조가 없는 코드에 대해 문서화 생성하기