CF technical-writing
Активируйте этот навык всякий раз, когда пользователь просит написать, структурировать или улучшить документацию для разработчиков. Охватывает шаблоны README, документацию API (OpenAPI, JSDoc, TSDoc), записи решений по архитектуре (ADR), RFC, журналы изменений, руководства по эксплуатации (runbooks), диаграммы как код (Mermaid, D2, PlantUML), руководства по стилю технического письма, генераторы сайтов документации (Docusaurus, Starlight, MkDocs, VitePress), рабочие процессы CI для документации как кода и лучшие практики примеров кода. Предоставляет полные шаблоны и справочник по распространенным ошибкам.
машинный переводПоказать оригиналСкрыть оригинал«Activate this skill whenever a user asks to write, structure, or impro…»
Activate this skill whenever a user asks to write, structure, or improve developer documentation. Covers README templates, API documentation (OpenAPI, JSDoc, TSDoc), Architecture Decision Records, RFCs, changelogs, runbooks, diagram-as-code (Mermaid, D2, PlantUML), technical writing style guides, documentation site generators (Docusaurus, Starlight, MkDocs, VitePress), docs-as-code CI workflows, and code example best practices. Provides complete templates and a common pitfalls reference.
Активируйте этот навык всякий раз, когда пользователь просит написать, структурировать или улучшить документацию для разработчиков.
Как процесс F 53/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: CONTRIBUTING.md, LICENSE
Чем это грозит
Скилл содержит фрагменты, которые в чужих руках стоят денег или данных. Ниже, что рискует потерять тот, кто установит, и что должен сделать автор.
Скилл содержит команды, которые удаляют файлы, переписывают диски или исполняют код, скачанный из сети. Агент может выполнить их без вопроса, если считает, что так требует инструкция.
Замените разрушительные команды на безопасные аналоги с подтверждением, ограничьте область действия конкретной папкой и не тяните код через curl | bash: укажите версию и контрольную сумму.
Как улучшить
- Разберите находки высокой серьёзности: каждая стоит 18 баллов безопасности. Если это ложное срабатывание, добавьте код правила в guard.allow в spec.yaml.
- Тело SKILL.md длиннее 5 000 токенов: вынесите справочные детали в references/ и подключайте по необходимости.
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 2
-
высокая Опасные команды
cmd-pipe-to-shellSKILL.md:171Скачивание и запуск удалённого кода с неизвестного хоста (pipe в shell)curl -fsSL https://get.my-cli.dev | sh
Средние и низкие: 1
-
низкая Утечка данных
read-dotenvSKILL.md:308Чтение файла .envcp .env.example .env
Просканировано файлов: 7. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
body-longтело SKILL.md ≈ 7945 токенов (рекомендуется < 5000); вынесите детали в references/ - предупреждение
missing-refссылка на отсутствующий файл: CONTRIBUTING.md - предупреждение
missing-refссылка на отсутствующий файл: LICENSE
Процессный рейтинг: все десять параметров 53/100
- 0Инструменты и файлы. Не хватает 2 файла(ов): CONTRIBUTING.md, LICENSE
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 30Повторный запуск. Изменяющих операций: 15, без проверки текущего состояния
- 60Ошибки и развилки. Развилок: 2
- 70Когда включается. Сказано, когда применять, но не сказано, когда не стоит
- 70Входы и предусловия. Входные данные и предусловия перечислены
- 70Стоимость исполнения. Тело инструкции 7945 токенов
- 100Шаги. Шагов: 24
- 100Согласованность. Имя и обязательные поля на месте
- 100Отчётность по ходу. Скилл сообщает о ходе работы
- low Разделов верхнего уровня: 13. Похоже на несколько доменов в одном скилле
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- -42 справочных файлов, но SKILL.md на них не ссылается: модель их не откроет
- -31 из 1 скриптов не упомянуты в SKILL.md
- +2Инструкции на одном языке
- +3Длина description 492 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 71 заголовков
- +3Пошаговые инструкции: 24 пунктов
- +4Есть примеры (57 блоков кода)
- +1Лицензия указана
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 59.