AIKraft/Skills/code-documentation

code-documentation

Генерирует и улучшает документацию для кода, API, библиотек и репозиториев. Создает README, справочники API, комментарии, архитектурные описания и changelog. Полезно при запросах на создание документации или анализ кодовой базы.

BYBytedance official Документы ★ 83.4k

Что делает навык

Навык генерирует профессиональную и комплексную документацию для проектов, кодовых баз, библиотек и API, следуя лучшим отраслевым практикам. Он создает материалы, точные и структурированные, полезные как для новых участников, так и для опытных разработчиков.

Когда применять

  • Создание файлов README.md с бейджами, инструкциями по установке, примерами использования и ссылками на API.
  • Генерация справочной документации по API на основе анализа исходного кода.
  • Написание архитектурной документации и диаграмм проектирования.
  • Создание руководств по онбордингу и внесению вкладов (contribution guides) для разработчиков.
  • Генерация changelog на основе истории коммитов или заметок к релизам.

Как работает

  1. Анализирует сложность проекта и потребности пользователя для выбора формата вывода.
  2. Генерирует документацию, адаптируя стиль под язык и экосистему проекта.
  3. Создает inline-документацию, следуя специфичным для языка конвенциям (JSDoc, docstrings, GoDoc, Javadoc, Rustdoc).
  4. Формирует выходные данные от одного файла README до многостраничных руководств.
  5. Обеспечивает соответствие документации лучшим практикам (React, Django, Stripe, Kubernetes).

Примеры запросов агенту

Сгенерируй comprehensive README.md для моего проекта с бейджами и инструкцией по установке.
Создай справочную документацию по API на основе предоставленного исходного кода.
Напиши руководство по внесению вкладов (contribution guide) для разработчиков.

Описание составлено по SKILL.md навыка, сверено 07.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «bytedance-code-documentation» из репозитория: # https://github.com/bytedance/deer-flow
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r bytedance-code-documentation/ ~/.claude/skills/bytedance-code-documentation/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.