Преобразует файлы с кодом в обучающие ресурсы, добавляя контекстные пояснительные комментарии, адаптированные под определенный уровень знаний.
- Звёзды на GitHub
- 41 038
- Файлы
- 1
- Последний коммит
- 11 нояб. 2026 г.
- Лицензия
- MIT
- Разрешённые инструменты
- —
Что делает навык add-educational-comments?
Преобразует файлы с кодом в обучающие ресурсы, добавляя контекстные пояснительные комментарии, адаптированные под определенный уровень знаний.
Сводка сгенерирована из SKILL.md навыка.
О skill add-educational-comments
Основная функция этого SKILL — превращение исходного кода в интерактивные учебные материалы. Он предназначен для разработчиков и студентов, которые хотят превратить существующие файлы в образовательные ресурсы, внедряя контекстные пояснения непосредственно в код. Агент должен загружать этот инструмент, когда пользователь предоставляет файл и запрашивает более глубокое понимание синтаксиса, проектных решений или архитектурных паттернов, представленных в этом файле.
Процесс включает анализ кода и добавление комментариев, объясняющих логику использования конкретных идиом или внутренних механизмов языка. Инструмент стремится увеличить длину файла на 125% за счет этих заметок, соблюдая при этом жесткий лимит в 400 новых строк, чтобы избежать чрезмерного раздувания кода. Он поддерживает различные языки программирования, включая Python, Haskell, F#, Nim, Cobra, YAML и Makefiles.
Пользователи могут настраивать процесс с помощью специальных параметров, таких как Comment Detail (детализация комментариев), Repetitiveness (повторяемость) и User Knowledge (уровень знаний пользователя) по шкале от 1 до 3. Инструмент также поддерживает Line Number Referencing для связи связанных пояснений и может вкладывать комментарии внутрь блоков кода для сохранения правильных отступов и читаемости.
Что агент может делать с ним
- 1Онбординг младших разработчиковПревратите сложную кодовую базу в пошаговое руководство, добавляя базовые пояснения для новичков.
- 2Углубление экспертизы в языкеДобавляйте технический контекст, касающийся производительности и архитектуры, для опытных специалистов.
- 3Стандартизация технической документацииПрименяйте единообразные обучающие заметки к файлам, сохраняя оригинальную кодировку и стиль отступов.
- 4Создание структурированных учебных пособийГенерируйте пронумерованную последовательность заметок для связи смежных концепций программирования по всему файлу.
Написано на основе skill SKILL.md. Каждый сценарий использования проверен по цитате из него.
Как установить навык add-educational-comments
Каждая команда копирует папку навыка в каталог навыков клиента. Перезапустите клиент или начните новую сессию, чтобы загрузить его.Установка навыка add-educational-comments в Claude Code
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsУстановка навыка add-educational-comments в Claude Code (project)
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsУстановка навыка add-educational-comments в Codex
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsУстановка навыка add-educational-comments в Gemini CLI
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsУстановка навыка add-educational-comments в Claude.ai
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
Автоматические проверки
Запущено 15 нояб. 2026 г.Полный отчёт →Прошёл наши автоматические проверки. Это не аудит безопасности: прочитайте скрипты, прежде чем агент их запустит. Как работают проверки · Что исправить, чтобы получить больше баллов
- Связанный и доступный исходный репозиторийgithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Пройдено
- Open source лицензия (OSI)MITspdx.org/licenses/MIT.html ↗Пройдено
- Коммит или релиз за последний год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 Skillsthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Проблема
SKILL.md
Открыть на GitHubAdd 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.
Файлы в этом навыке
1Вопросы о навыке add-educational-comments
Как установить навык add-educational-comments в Claude Code?
Выполните npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments. Claude Code загружает навыки из ~/.claude/skills (все проекты) или .claude/skills (один проект) и использует навык, когда его описание соответствует задаче.
Какие клиенты могут использовать навык add-educational-comments?
Любой клиент, который читает формат Agent Skills: Claude Code, Codex, Gemini CLI и claude.ai (загрузить как ZIP). Скрипты в навыке выполняются только там, где клиент разрешает выполнение кода.
Какой объем контента будет добавлен в мой файл?
Инструмент стремится увеличить общее количество строк на 125% за счет обучающих комментариев, но имеет жесткое ограничение — не более 400 новых строк.
Изменит ли инструмент функциональность или форматирование моего кода?
Нет, инструмент спроектирован так, чтобы сохранять структуру файла, кодировку, отступы и корректность сборки.
Что произойдет, если я не укажу имя файла?
Агент попросит вас предоставить файл или файлы, предложив нумерованный список наиболее подходящих вариантов, если будет найдено несколько файлов.