AIKraft/Skills/technical-writer

technical-writer

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

shubhamsaboo official Документы ★ 140.7k

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

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

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

  • Написание документации к API (API Reference)
  • Создание файлов README и руководств по установке (setup guides)
  • Разработка пользовательских руководств и обучающих материалов (tutorials)
  • Документирование архитектуры и дизайна системы
  • Написание changelog, release notes и онбординг-гайдов

Как работает

  1. Определить цель пользователя и ответить на вопрос «зачем мне это нужно?» до описания функционала
  2. Использовать активный залог, настоящие времена и короткие предложения (до 25 слов)
  3. Структурировать контент от простого к сложному (progressive disclosure), начиная с Quick Start
  4. Включать практические примеры, полные рабочие образцы кода и ожидаемый вывод
  5. Применять форматирование для сканируемости: описательные заголовки, списки, блоки кода с подсветкой синтаксиса
  6. Использовать прямое обращение «you» и профессиональный, но разговорный тон

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

Напиши README для CLI-инструмента, который сортирует файлы по размеру
Создай документацию для функции API, которая принимает параметры и возвращает JSON
Напиши пошаговое руководство (tutorial) по настройке проекта с примерами кода

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

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

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

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