documentation-generation-doc-generate
코드에서 포괄적인 문서 생성
코드와 문서를 자동으로 동기화하세요. 이 스킬은 소스 코드에서 정보를 추출하여 코드베이스가 진화함에 따라 최신 상태를 유지하는 API 명세, 아키텍처 다이어그램, 사용자 가이드를 생성합니다.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-generation-doc-generate”。 src/routes/에서 Python API 라우트 분석
预期结果:
- OpenAPI 3.0 명세 파일 (openapi.yaml)
- 인터랙티브 API 문서 HTML 페이지
- 각 엔드포인트에 대한 Python, JavaScript, cURL 의 코드 예시
正在使用“documentation-generation-doc-generate”。 마이크로서비스 아키텍처 문서화
预期结果:
- 서비스 관계를 보여주는 시스템 아키텍처 다이어그램
- 기술 스택과 책임이 포함된 컴포넌트 문서
- 핵심 비즈니스 프로세스에 대한 데이터 흐름 다이어그램
安全审计
安全This skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
质量评分
你能构建什么
API 문서 생성
코드베이스 주석과 라우트 정의로부터 OpenAPI 명세와 인터랙티브 API 문서를 자동으로 생성합니다.
아키텍처 문서
임포트, 의존성, 코드 구조를 분석하여 시스템 아키텍처 다이어그램과 컴포넌트 문서를 생성합니다.
문서 파이프라인 자동화
문서가 코드와 동기화되도록 모든 코드 커밋 시 문서를 재생성하고 배포하는 CI/CD 워크플로우를 설정합니다.
试试这些提示
./src/api/ 디렉토리의 Python 파일을 분석하여 모든 엔드포인트, 요청/응답 스키마, 인증 요구사항이 포함된 OpenAPI 3.0 명세를 생성하세요.
코드 구조를 기반으로 설치 방법, 구성 옵션, 사용 예시, 기여 가이드라인이 포함된 포괄적인 README.md 를 생성하세요.
서비스 모듈과 임포트를 검토하여 시스템 아키텍처, 데이터 흐름, 컴포넌트 의존성을 보여주는 Mermaid 다이어그램을 생성하세요.
API 레퍼런스, 아키텍처 개요, 시작 가이드, 배포 지침을 포함한 완전한 문서를 생성하세요. 검색 기능이 있는 생성된 아티팩트로 문서 사이트를 설정하세요.
最佳实践
- CI/CD 의 일부로 문서 생성을 실행하여 문서를 코드 변경과 동기화
- 커버리지가 임계값 이하로 떨어질 때 빌드를 실패하게 하는 문서 커버리지 체크 포함
- 생성된 문서의 정확성을 검토하고 필요한 경우 인간의 컨텍스트 추가
避免
- 문서를 한 번 생성하고 코드가 진화해도 업데이트하지 않음
- 정확성을 위한 인간의 검토 없이 생성된 문서를 게시
- API 키나 내부 URL 과 같은 민감한 정보를 생성된 문서에 포함