documentation-templates
전문 문서 빠르게 작성하기
이 스킬은 README 파일, API 문서, 코드 주석, 변경 로그, AI 친화적 문서 형식을 위한 즉시 사용 가능한 템플릿을 제공합니다.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-templates”。 documentation-templates를 사용하여 Node.js API용 README 생성
预期结果:
섹션이 포함된 완전한 README.md: 제목 + 한 줄 요약, Quick Start, Features, Configuration 테이블, API Reference 링크, Contributing 가이드라인, License
正在使用“documentation-templates”。 documentation-templates를 사용하여 GET /users 엔드포인트 문서화
预期结果:
엔드포인트 설명, 파라미터 테이블(id: string, 필수), 응답 코드(200, 404), 예시 요청/응답이 포함된 API 문서
正在使用“documentation-templates”。 documentation-templates를 사용하여 데이터베이스 선택에 대한 ADR 생성
预期结果:
상태(Status: Accepted/Deprecated/Superseded), 맥락(결정이 필요한 이유), 결정(무엇이 결정되었는지), 결과(-trade-off)가 포함된 ADR 문서
安全审计
安全All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.
检测到的模式
质量评分
你能构建什么
새 프로젝트 설정
README, API 문서, 변경 로그 템플릿으로 새 프로젝트의 문서를 빠르게 스캐폴딩합니다.
문서 표준
표준화된 템플릿을 사용하여 팀 프로젝트 전반에서 일관된 문서 스타일을 유지합니다.
AI 에이전트 통합
Claude 및 Codex와 같은 AI 에이전트가 이해하고 효과적으로 사용할 수 있는 문서를 작성합니다.
试试这些提示
documentation-templates 스킬을 사용하여 [project type] 프로젝트용 README.md를 생성하세요. Quick Start, Features, Configuration 섹션을 포함해야 합니다.
documentation-templates 스킬을 사용하여 [list endpoints]의 엔드포인트를 가진 REST API의 API 문서를 생성하세요.
documentation-templates 스킬을 사용하여 [describe function purpose]하는 함수에 JSDoc 주석을 추가하세요.
documentation-templates 스킬을 사용하여 [decision title]에 대한 ADR을 생성하세요. Context, Decision, Consequences 섹션을 포함해야 합니다.
最佳实践
- 자세한 문서를 추가하기 전에 먼저 필수 섹션(제목, 빠른 시작, 기능)으로 시작하세요
- 템플릿을 시작점으로 사용하고 프로젝트 요구에 맞게 구조를 조정하세요
- 문서를 최신 상태로 유지하세요 - 오래된 문서는 아예 없는 문서보다 못합니다
- 사용자가 빠르게 이해할 수 있도록 문서에 예제를 포함하세요
避免
- 프로젝트 맥락을 맞춤화하지 않고 템플릿을 그대로 복사하지 마세요
- 사용자向け README 파일에 구현 세부 정보를 문서화하지 마세요
- Quick Start 섹션을 건너뛰지 마세요 - 사용자는 빠르게 시작하고 싶어합니다
- AI 에이전트가 구문 분석할 수 없는 오래된 문서 형식을 사용하지 마세요