스킬 when-documenting-code-use-doc-generator

📦

when-documenting-code-use-doc-generator

Name: when-documenting-code-use-doc-generator
Author: DNYoussef

v1.0.0 콘텐츠 리비전 r1 높은 위험 ⚙️ 외부 명령어🌐 네트워크 접근📁 파일 시스템 접근🔑 환경 변수

완전한 코드 문서 생성

코드베이스에는 최신 API 참조, README 파일, 주석, 다이어그램이 부족한 경우가 많습니다. 이 skill은 프로젝트 구조를 분석하고 Claude, Codex, Claude Code 워크플로를 위한 문서화 자산을 생성합니다.

지원: Claude Codex Code(CC)

⚠️ 38 나쁨

Maintain this Skill? Claim it ⚠️ 38 나쁨

설치 전에 중지하고 확인을 요청하세요.

계획을 검토하고 파일을 변경하기 전에 사용자의 명시적 동의를 받으세요.

내 에이전트로 설치

이 요청을 에이전트에 복사하세요. 공식 Skill 페이지와 매니페스트가 포함되어 있습니다.

에이전트 요청

Review the Skillstore skill "when-documenting-code-use-doc-generator" from https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator.md and its manifest at https://skillstore.io/api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.

에이전트는 계속해서 계획을 표시하고 보안 정책에서 요구하는 확인을 요청해야 합니다.

에이전트가 읽기 쉬운 리소스

AI 에이전트, 크롤러, 스크립트가 전체 페이지 대신 정리된 컨텍스트만 필요할 때 이 링크를 사용하세요.

Markdown 상세 GET /skills/dnyoussef-when-documenting-code-use-doc-generator.md 서명된 manifest GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest 서명된 lockfile GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/lockfile

테스트해 보기

"when-documenting-code-use-doc-generator" 사용 중입니다. Node.js API 프로젝트에 라우트는 있지만 API 참조가 없습니다.

예상 결과:

이 skill은 엔드포인트 요약, 인증 메모, 응답 설명, 생성된 문서 파일 링크가 포함된 API 개요를 생성합니다.

"when-documenting-code-use-doc-generator" 사용 중입니다. 저장소에 오래된 README와 누락된 설정 지침이 있습니다.

예상 결과:

이 skill은 프로젝트 개요, 사전 요구 사항, 설치, 사용법, 테스트, 구성, 기여 섹션이 포함된 갱신된 README 초안을 작성합니다.

"when-documenting-code-use-doc-generator" 사용 중입니다. 소스 폴더에 주석이 없는 public 함수가 포함되어 있습니다.

예상 결과:

이 skill은 문서화 커버리지를 보고하고 매개변수 및 반환 설명이 필요한 함수에 대한 인라인 주석을 제안합니다.

보안 감사

높은 위험

v9 • 2026. 7. 5. 버전별 보고서 열기

Most static findings are false positives from Markdown examples, generated documentation placeholders, or sample configuration names. The executable slash-command scripts are real shell entry points, and the larger concern is their unpinned npx execution of claude-flow plus default writes to repository documentation files.

스캔된 파일

3,881

분석된 줄 수

검토 항목

오탐 무시됨

확인된 보안 우려 사항 (2)

높음

slash-command-doc-api.sh:100-103 slash-command-doc-inline.sh:98-102 slash-command-doc-readme.sh:87-91

Unpinned Third-Party Package Execution

The slash-command scripts invoke npx claude-flow@alpha for hooks and memory storage. Running an alpha npm package during documentation generation can download and execute third-party code.

The scripts directly call npx with an external package name in executable paths. This is a clear supply-chain execution risk even though it appears intended for workflow coordination.

중간

slash-command-doc-readme.sh:93-99 slash-command-doc-readme.sh:167-178 slash-command-doc-api.sh:94-96 slash-command-doc-api.sh:231-233

Documentation Scripts Modify Repository Files by Default

The README and API scripts create or overwrite documentation files in the current project. This can change repository contents without a dry-run default or confirmation prompt.

The cited script paths create directories, copy generated specs, back up README.md, and write README content. These are intended actions but still affect repository state by default.

기능 검토 항목 (3)

이 스킬에 대해 예상될 수 있는 실제 로컬 기능이므로 검토가 필요하지만, 확인된 악의적 동작으로는 집계되지 않습니다.

중간

slash-command-doc-api.sh:1

Unix shell invocation

#!/bin/bash

This is an executable Bash entry point that scans project files and writes documentation outputs. Shell automation is expected, but it is still real command-execution behavior for a marketplace skill.

중간

slash-command-doc-inline.sh:1

Unix shell invocation

#!/bin/bash

중간

slash-command-doc-readme.sh:1

Unix shell invocation

#!/bin/bash

위험 요인

⚙️ 외부 명령어 (180)

🌐 네트워크 접근 (34)

📁 파일 시스템 접근 (45)

🔑 환경 변수 (5)

PROCESS.md:734 SKILL.md:491 SKILL.md:408 SKILL.md:409 slash-command-doc-readme.sh:465

감사자: codex 감사 이력 보기 →

이 보고서 공유 및 인용

버전이 지정된 평가 보고서, 중립 배지, 임베드 카드 및 인용을 공유하세요. Skillstore는 근거를 보고하지만 이 Skill의 안전 여부를 판단하지 않습니다.

버전별 보고서 열기

보고서 링크 복사

https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 배지

[![Skillstore security assessment](https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg)](https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge)

HTML 배지

<a href="https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

임베드 카드

<iframe src="https://skillstore.io/embed/skills/dnyoussef-when-documenting-code-use-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

학술 인용 (APA · BibTeX · CFF)

APA 인용

DNYoussef. (2026). when-documenting-code-use-doc-generator security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9

BibTeX 인용

@techreport{dnyoussef-dnyoussef-when-documenting-code-use-doc-generator-2026,
  author = {DNYoussef},
  title = {when-documenting-code-use-doc-generator security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "when-documenting-code-use-doc-generator security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
  - name: "DNYoussef"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9"
identifiers:
  - type: other
    value: "skillstore:dnyoussef-when-documenting-code-use-doc-generator:audit:9"
    description: "Skillstore immutable audit report identifier"

Skillstore 점수

이 점수의 이유 증거 신뢰도: 중간

아키텍처

100

유지보수성

콘텐츠

커뮤니티

사양 준수

만들 수 있는 것

Backend API 문서화

서비스 저장소를 위한 OpenAPI 스타일 참조, 엔드포인트 요약, 인증 메모, 사용 예제를 생성합니다.

프로젝트 온보딩 문서 갱신

저장소 메타데이터를 기반으로 설정, 구성, 테스트, 기여, 지원 섹션이 포함된 README를 만듭니다.

코드 주석 커버리지 개선

문서화되지 않은 함수를 식별하고 지원되는 언어 스타일에 맞는 인라인 주석 지침을 만듭니다.

이 프롬프트를 사용해 보세요

기본 문서 생성

이 skill을 사용하여 현재 저장소를 검토하고 기본 README 및 API 문서를 생성하세요. 출력은 간결하게 유지하고 변경된 파일을 나열하세요.

API 참조 생성

이 skill을 사용하여 이 프로젝트의 REST API를 문서화하세요. 엔드포인트, 요청 형식, 응답 요약, 인증 메모, 검증 경고를 포함하세요.

인라인 주석 추가

이 skill을 사용하여 src에서 문서화되지 않은 public 함수를 찾으세요. JSDoc, TSDoc 또는 Python docstrings를 추가하거나 제안하고, 비즈니스 로직은 변경하지 마세요.

전체 문서 세트 구축

이 skill을 사용하여 README, API 참조, 아키텍처 메모, 인라인 주석 권장 사항, 문서화 공백 보고서를 생성하세요. 가능하면 dry-run mode로 실행하고 편집 전에 위험한 쓰기를 표시하세요.

모범 사례

깨끗한 브랜치에서 skill을 실행하고 병합하기 전에 생성된 파일을 검토하세요.
대상 문서 유형, 선호 형식, 커버리지 목표를 제공하세요.
예제에 비밀 정보를 포함하지 말고 게시 전에 플레이스홀더를 교체하세요.

피하기

커밋되지 않은 중요한 변경 사항이 있는 저장소에 생성 스크립트를 실행하지 마세요.
인증 및 데이터 노출 여부를 확인하기 전에 생성된 API 세부 정보를 게시하지 마세요.
검증 없이 예제가 프로덕션에 바로 사용할 수 있다고 가정하지 마세요.

자주 묻는 질문

이 skill은 프로젝트 파일을 편집하나요?

예. 포함된 스크립트는 README 및 docs 출력물을 만들 수 있으므로 커밋하기 전에 변경 사항을 검토하세요.

OpenAPI 문서를 생성할 수 있나요?

예. 이 skill에는 OpenAPI 스타일 참조와 엔드포인트 요약을 생성하는 API 문서화 워크플로가 포함되어 있습니다.

이 skill은 어떤 언어를 설명하나요?

문서에서는 JavaScript, TypeScript, Python, Java, C#, Go, Rust 문서화 스타일을 설명합니다.

생성된 모든 문서를 검증하나요?

아니요. 검증 지침을 제공하지만, 생성된 콘텐츠에는 여전히 사람의 검토와 도구별 검사가 필요합니다.

네트워크 액세스가 필요한가요?

일부 스크립트는 npx로 외부 claude-flow 도구를 호출하며, 패키지가 설치되어 있지 않으면 네트워크 액세스가 필요할 수 있습니다.

비공개 저장소에 적합한가요?

주의해서 사용하세요. 이 skill은 프로젝트 파일을 스캔하며 내부 API 또는 구성 이름을 노출하는 문서를 생성할 수 있습니다.

개발자 세부 정보

작성자

DNYoussef

라이선스

MIT

작성자 버전

v1.0.0

Skillstore 리비전

리포지토리

https://github.com/DNYoussef/ai-chrome-extension/tree/main/.claude/skills/documentation/when-documenting-code-use-doc-generator

참조

c579efd02184f1128d6741d16e6c8d951d7d4208

유지보수 최신성

2026. 7. 18.

사용량

6 다운로드 · 230 조회

파일 구조

📄 process-diagram.gv

📄 PROCESS.md

📄 README.md

📄 SKILL.md

📄 slash-command-doc-api.sh

📄 slash-command-doc-inline.sh

📄 slash-command-doc-readme.sh

📄 subagent-doc-generator.md