documentation-writer
Профессиональный помощник для написания технической документации согласно методологии Diátaxis.
Суть
Что это за skill и зачем он нужен
Documentation Writer — это инструмент для создания качественной документации, который строго следует принципам фреймворка Diátaxis. Агент помогает структурировать контент в четырех ключевых категориях: руководства (Tutorials), пошаговые инструкции (How-to Guides), справочные материалы (Reference) и теоретические пояснения (Explanation). Процесс работы включает уточнение целей пользователя, создание плана документа и последующую генерацию текста в формате Markdown.
Установка
Как установить
npx skills add https://github.com/github/awesome-copilot --skill documentation-writerСценарии
Когда использовать
Подходит
- Создание новых руководств пользователя или разработчика.
- Разработка технической документации, требующей строгой структуры.
- Необходимость привести разрозненные описания к единому стилю и тону.
- Потребность в четком разделении между учебными материалами и справочными данными.
Не подходит
- Для написания творческих текстов или маркетинговых материалов.
- Когда задача требует глубокого анализа внешних ресурсов без предоставления ссылок пользователем.
- Если проект не предполагает использования Markdown для документации.
Доверие
Проверки безопасности
Проверка вернула предупреждение. Перед установкой стоит просмотреть исходники, команды и доступы.
Проверка не нашла критичных проблем.
Низкий риск · проблем не найдено.
Предупреждений нет.
Оценка 93/100 · проанализировано 2 раздела.
Похожие