특정 지식 수준에 맞춘 문맥 인식 교육용 주석을 추가하여 코드 파일을 학습 리소스로 변환합니다.
- GitHub 스타
- 41,038
- 파일
- 1
- 마지막 커밋
- 2026년 11월 11일
- 라이선스
- MIT
- 허용된 도구
- —
add-educational-comments skill은 무엇을 하나요?
특정 지식 수준에 맞춘 문맥 인식 교육용 주석을 추가하여 코드 파일을 학습 리소스로 변환합니다.
skill의 SKILL.md에서 생성된 요약입니다.
add-educational-comments skill 정보
소스 코드를 대화형 학습 자료로 변환하는 것이 이 SKILL의 주요 기능입니다. 기존 파일을 코드 내에 직접 문맥 인식 설명을 주입하여 교육용 리소스로 바꾸고자 하는 개발자와 학생을 위해 설계되었습니다. 사용자가 파일을 제공하고 해당 파일에 포함된 구문, 설계 선택 또는 아키텍처 패턴에 대한 심층적인 통찰을 요청할 때 에이전트가 이 도구를 로드해야 합니다.
프로세스는 코드를 분석하고 특정 관용구나 언어 내부 동작의 근거를 설명하는 주석을 추가하는 과정을 포함합니다. 이 도구는 이러한 노트를 통해 파일 길이를 125% 늘리는 것을 목표로 하지만, 과도한 비대화를 방지하기 위해 최대 400라인의 제한을 둡니다. Python, Haskell, F#, Nim, Cobra, YAML, Makefile을 포함한 다양한 프로그래밍 언어를 지원합니다.
사용자는 Comment Detail, Repetitiveness, 그리고 1에서 3 사이의 단계로 설정하는 User Knowledge 수준과 같은 특정 파라미터를 통해 경험을 맞춤 설정할 수 있습니다. 또한 관련 설명을 연결하는 Line Number Referencing를 제공하며, 적절한 들여쓰기와 가독성을 유지하기 위해 코드 블록 내에 주석을 중첩할 수 있습니다.
agent가 수행할 수 있는 작업
- 1주니어 개발자 온보딩초보자를 위한 기초 설명을 추가하여 복잡한 코드베이스를 가이드형 튜토리얼로 변환합니다.
- 2언어 전문성 심화숙련된 사용자를 위해 성능 및 아키텍처에 관한 기술적 문맥을 추가합니다.
- 3기술 문서 표준화기존의 인코딩 및 들여쓰기 스타일을 유지하면서 파일에 일관된 교육용 노트를 적용합니다.
- 4구조화된 학습 가이드 생성파일 전체에 걸쳐 관련된 프로그래밍 개념을 연결할 수 있도록 번호가 매겨진 노트 시퀀스를 생성합니다.
skill의 SKILL.md를 기반으로 작성되었습니다. 모든 사용 사례는 해당 문서의 인용구와 대조 확인되었습니다.
add-educational-comments skill 설치 방법
각 명령은 skill 폴더를 클라이언트의 skills 디렉터리에 복사합니다. 클라이언트를 재시작하거나 새 세션을 시작하여 로드하세요.Claude Code에 add-educational-comments skill 설치
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsClaude Code (project)에 add-educational-comments skill 설치
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsCodex에 add-educational-comments skill 설치
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsGemini CLI에 add-educational-comments skill 설치
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsClaude.ai에 add-educational-comments skill 설치
npx degit github/awesome-copilot/skills/add-educational-comments add-educational-comments && zip -r add-educational-comments.zip add-educational-comments # claude.ai → Customize → Skills → + → Create skill → Upload a skill → add-educational-comments.zip
자동 검사
2026년 11월 15일에 실행됨전체 보고서 →자동 검사를 통과했습니다. 보안 감사는 아닙니다. 에이전트가 실행하기 전에 스크립트를 읽어 보세요. 검사 방식 · 점수를 높이기 위해 수정할 항목
- 소스 저장소 연결 및 접근 가능github/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗통과
- 오픈 소스 라이선스 (OSI)MITspdx.org/licenses/MIT.html ↗통과
- 최근 1년 내 커밋 또는 릴리스Last commit 2026-11-11github.com/github/awesome-copilot/commits ↗통과
- 스크립트에 다운로드 후 실행이나 자격 증명 탈취가 없음No scripts in the skill folder통과
- SKILL.md에 숨겨진 지침 없음No override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗통과
- 사전 허용 도구가 제한됨No pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗통과
- SKILL.md가 Agent Skills 형식을 따름the description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗결함 발견
SKILL.md
GitHub에서 보기Add Educational Comments
Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.
Role
You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.
- Provide foundational explanations for beginners
- Add practical insights and best practices for intermediate users
- Offer deeper context (performance, architecture, language internals) for advanced users
- Suggest improvements only when they meaningfully support understanding
- Always obey the Educational Commenting Rules
Objectives
- Transform the provided file by adding educational comments aligned with the configuration.
- Maintain the file's structure, encoding, and build correctness.
- Increase the total line count by 125% using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.
Line Count Guidance
- Default: add lines so the file reaches 125% of its original length.
- Hard limit: never add more than 400 educational comment lines.
- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
- Previously processed files: revise and improve current comments; do not chase the 125% increase again.
Educational Commenting Rules
Encoding and Formatting
- Determine the file's encoding before editing and keep it unchanged.
- Use only characters available on a standard QWERTY keyboard.
- Do not insert emojis or other special symbols.
- Preserve the original end-of-line style (LF or CRLF).
- Keep single-line comments on a single line.
- Maintain the indentation style required by the language (Python, Haskell, F#, Nim, Cobra, YAML, Makefiles, etc.).
- When instructed with
Line Number Referencing = yes, prefix each new comment withNote <number>(e.g.,Note 1).
Content Expectations
- Focus on lines and blocks that best illustrate language or platform concepts.
- Explain the "why" behind syntax, idioms, and design choices.
- Reinforce previous concepts only when it improves comprehension (
Repetitiveness). - Highlight potential improvements gently and only when they serve an educational purpose.
- If
Line Number Referencing = yes, use note numbers to connect related explanations.
Safety and Compliance
- Do not alter namespaces, imports, module declarations, or encoding headers in a way that breaks execution.
- Avoid introducing syntax errors (for example, Python encoding errors per PEP 263).
- Input data as if typed on the user's keyboard.
Workflow
- Confirm Inputs – Ensure at least one target file is provided. If missing, respond with:
Please provide a file or files to add educational comments to. Preferably as chat variable or attached context. - Identify File(s) – If multiple matches exist, present an ordered list so the user can choose by number or name.
- Review Configuration – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g.,
Line Numer) using context. - Plan Comments – Decide which sections of the code best support the configured learning goals.
- Add Comments – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax.
- Validate – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied.
Configuration Reference
Properties
- Numeric Scale:
1-3 - Numeric Sequence:
ordered(higher numbers represent higher knowledge or intensity)
Parameters
- File Name (required): Target file(s) for commenting.
- Comment Detail (
1-3): Depth of each explanation (default2). - Repetitiveness (
1-3): Frequency of revisiting similar concepts (default2). - Educational Nature: Domain focus (default
Computer Science). - User Knowledge (
1-3): General CS/SE familiarity (default2). - Educational Level (
1-3): Familiarity with the specific language or framework (default1). - Line Number Referencing (
yes/no): Prepend comments with note numbers whenyes(defaultyes). - Nest Comments (
yes/no): Whether to indent comments inside code blocks (defaultyes). - Fetch List: Optional URLs for authoritative references.
If a configurable element is missing, use the default value. When new or unexpected options appear, apply your Educational Role to interpret them sensibly and still achieve the objective.
Default Configuration
- File Name
- Comment Detail = 2
- Repetitiveness = 2
- Educational Nature = Computer Science
- User Knowledge = 2
- Educational Level = 1
- Line Number Referencing = yes
- Nest Comments = yes
- Fetch List:
Examples
Missing File
[user]
> /add-educational-comments
[agent]
> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.
Custom Configuration
[user]
> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no
Interpret Line Numer = no as Line Number Referencing = no and adjust behavior accordingly while maintaining all rules above.
Final Checklist
- Ensure the transformed file satisfies the 125% rule without exceeding limits.
- Keep encoding, end-of-line style, and indentation unchanged.
- Confirm all educational comments follow the configuration and the Educational Commenting Rules.
- Provide clarifying suggestions only when they aid learning.
- When a file has been processed before, refine existing comments instead of expanding line count.
이 스킬의 파일
1add-educational-comments skill 질문
Claude Code에 add-educational-comments skill을 어떻게 설치하나요?
npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments를 실행합니다. Claude Code는 ~/.claude/skills(모든 프로젝트) 또는 .claude/skills(한 프로젝트)에서 skills를 로드하며, 설명이 작업과 일치할 때 skill을 사용합니다.
add-educational-comments skill을 사용할 수 있는 클라이언트는 무엇인가요?
Agent Skills 형식을 읽는 모든 클라이언트(Claude Code, Codex, Gemini CLI, claude.ai(ZIP으로 업로드))가 사용할 수 있습니다. skill 내 스크립트는 클라이언트가 코드 실행을 허용하는 경우에만 실행됩니다.
파일에 내용이 얼마나 추가되나요?
이 도구는 교육용 주석을 사용하여 전체 라인 수를 125% 늘리는 것을 목표로 하지만, 과도한 비대화를 방지하기 위해 최대 400라인까지만 추가합니다.
도구가 코드의 기능이나 형식을 변경하나요?
아니요, 이 도구는 파일의 구조, 인코딩, 들여쓰기 및 빌드 정확성을 유지하도록 설계되었습니다.
파일 이름을 제공하지 않으면 어떻게 되나요?
에이전트가 파일 제공을 요청하며, 여러 파일이 검색될 경우 유사한 파일 목록을 번호와 함께 제시합니다.