스킬 Reference Builder
📦
Reference Builder
안전
포괄적인 API 및 기술 문서 생성
수동으로 포괄적인 기술 문서를 작성하는 것은 시간이 많이 소요되고 오류가 발생하기 쉽습니다. 이 스킬은 일관된 서식과 철저한 파라미터 커버리지를 갖춘 완전한 참조 자료 생성을 자동화합니다.
지원: Claude Codex Code(CC)
1
스킬 ZIP 다운로드
2
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
3
토글을 켜고 사용 시작
테스트해 보기
"Reference Builder" 사용 중입니다. Document a REST API endpoint: POST /api/users with parameters: name (string, required), email (string, required), age (integer, optional)
예상 결과:
- ### POST /api/users
- **Description**: Creates a new user account in the system.
- **Parameters**:
- - `name` (string, required): User's full name, 2-100 characters
- - `email` (string, required): Valid email address, must be unique
- - `age` (integer, optional): User's age in years, 18-120
- **Returns**: User object with id, name, email, created_at
- **Errors**: 400 (validation), 409 (duplicate email), 500 (server error)
- **Example**:
- POST /api/users
- {"name": "Jane Doe", "email": "jane@example.com", "age": 30}
"Reference Builder" 사용 중입니다. Document a database User schema with fields: id, username, email, created_at, status
예상 결과:
- ### User Schema
- | Field | Type | Constraints | Description |
- |-------|------|-------------|-------------|
- | id | UUID | PRIMARY KEY | Unique identifier |
- | username | VARCHAR(50) | NOT NULL, UNIQUE | User's display name |
- | email | VARCHAR(255) | NOT NULL, UNIQUE | Contact email address |
- | created_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | Account creation time |
- | status | ENUM | NOT NULL, DEFAULT 'active' | Account status: active, suspended, deleted |
- **Indexes**: username_idx, email_idx, status_idx
- **Relationships**: One-to-many with Posts, One-to-one with Profile
보안 감사
안전v1 • 2/24/2026
This is a prompt-only skill containing no executable code. Static analysis scanned 0 files with 0 lines of code and detected no security patterns. The skill consists entirely of documentation instructions and prompt templates for creating technical references.
0
스캔된 파일
0
분석된 줄 수
0
발견 사항
1
총 감사 수
보안 문제를 찾지 못했습니다
감사자: claude
품질 점수
38
아키텍처
100
유지보수성
87
콘텐츠
31
커뮤니티
100
보안
74
사양 준수
만들 수 있는 것
API 참조 생성
완전한 파라미터 목록, 반환 유형, 오류 코드 및 사용 예시를 포함한 내부 또는 공개 API 를 위한 포괄적인 API 문서 작성.
구성 문서
모든 설정, 기본값, 제약 조건 및 환경별 값을 문서화하는 복잡한 애플리케이션을 위한 상세한 구성 가이드 생성.
SDK 문서
클래스 계층, 메서드 서명, 유형 정의 및 통합 예시를 포함한 포괄적인 SDK 참조 자료 제작.
이 프롬프트를 사용해 보세요
기본 API 메서드 문서
다음 API 엔드포인트를 완전한 참조 항목으로 문서화하십시오. 메서드 서명, 유형과 제약 조건이 있는 모든 파라미터, 반환 값, 가능한 오류 및 기본 사용 예시를 포함하십시오: 엔드포인트: [METHOD] [URL] 파라미터: [파라미터 목록] 컨텍스트: [수행 작업 설명]
구성 파라미터 참조
다음 설정에 대한 포괄적인 구성 참조 테이블을 작성하십시오. 각 파라미터에 대해 유형, 기본값, 유효 범위, 필수 여부, 환경 변수 이름 및 다른 설정에 대한 종속성을 문서화하십시오: [구성 파라미터 목록 제공]
예시가 포함된 스키마 문서
다음 데이터 모델에 대한 완전한 스키마 문서를 생성하십시오. 필드 유형, 유효성 검사 규칙, 제약 조건, 다른 모델과의 관계, 인덱싱 정보를 포함하고 세 가지 예시를 제공하십시오: 최소 유효 레코드, 완전히 채워진 레코드, 엣지 케이스: [스키마 정의 제공]
모범 사례
- Document behavior and intent, not implementation details - focus on what the code does, not how
- Include both happy path examples and error handling scenarios for complete coverage
- Use consistent terminology throughout all documentation - create and follow a glossary
피하기
- Writing examples that omit error handling - always show how to handle failures
- Using implementation-specific jargon instead of clear, user-focused language
- Creating documentation without version markers - always indicate which version each feature applies to
자주 묻는 질문
What types of documentation can this skill generate?
This skill generates API references, configuration guides, schema documentation, troubleshooting guides, migration guides, and complete module references. It covers any technical documentation that requires exhaustive parameter listings and structured formatting.
Do I need to provide source code for documentation?
Yes, this skill requires you to provide the source code, API specifications, or schema definitions you want documented. It cannot automatically extract documentation from your codebase - you must supply the materials to document.
How accurate is the generated documentation?
The documentation accuracy depends on the completeness of your source materials. Always verify generated documentation against actual implementations, especially for critical APIs or configuration guides used in production.
Can this skill document multiple programming languages?
Yes, the skill is language-agnostic and can document APIs, configurations, and schemas regardless of the programming language. It focuses on interface documentation rather than language-specific implementation details.
Does this skill support OpenAPI or Swagger specifications?
The skill can incorporate OpenAPI specifications as source material and can generate documentation in a format compatible with OpenAPI conventions. However, it does not automatically parse OpenAPI files - you must provide the relevant specification details.
How should I handle documentation for deprecated features?
Include a Deprecated section for each deprecated feature, specifying the version when deprecated, the recommended alternative, and a migration timeline. The skill will format these according to the standard entry format with clear migration guidance.