SKILLEMALL.ai
GitHub ↗ EN Войти

BD documentation-fundamentals

Руководство по стандартам документации, включая README, JSDoc и комментарии к коду. Используйте при написании документации, добавлении комментариев или объяснении кода. Обеспечивает соблюдение принципа «ПОЧЕМУ, а не ЧТО».

машинный переводПоказать оригиналСкрыть оригинал«Guides documentation standards including READMEs, JSDoc, and code comm…»

Guides documentation standards including READMEs, JSDoc, and code comments. Use when writing documentation, adding comments, or explaining code. Enforces "WHY not WHAT" principle.

DanielPodolsky/ownyourcode Agent Skills автор: DanielPodolsky 1 файл тело ≈ 1 727 токенов Открыть источникgithub.com↗ проанализирован 2 дн назад

Руководство по стандартам документации, включая README, JSDoc и комментарии к коду.

Как процесс D 46/100 · Процесс не доведён — слабые места: результат и критерий готовности, когда включается, входы и предусловия

СправочникТексты и документытип и темы размечены автоматически по тексту скилла
Запускается в: Claude / Claude Code ChatGPT / Codex Gemini CLI Cursor GitHub Copilot / VS Code Qwen Code Kimi Code CLI Z.ai (GLM) DeepSeek (Deep Code) Mistral Vibe LangChain (deepagents) OpenClaw Goose OpenCode
JSON
Технический рейтинг
B
94/100
безопасность, качество, тесты
Безопасность 60%
100
Качество 40%
84
Прогон на моделях
не было
Процессный рейтинг
D
46/100
Процесс не доведён
Результат и критерий готовности вес 14
0
Входы и предусловия вес 11
0
Ошибки и развилки вес 10
0
три самых слабых из десяти параметров · все десять

Как улучшить

    Для прогона на моделях — необязательно
    • Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
    • spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.

    Находки guard · 0

    ✓ Критических и высоких находок нет

    Просканировано файлов: 1. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.

    По спецификации Agent Skills

    • заметка edit-residue в тексте есть пометки об устаревшем (строки 287): проверьте, не остались ли старые правила рядом с новыми — полная проверка читает текст на противоречия

    Процессный рейтинг: все десять параметров 46/100

    • 0Результат и критерий готовности. Не сказано, что считать результатом
    • 0Входы и предусловия. Не сказано, что нужно иметь на входе
    • 0Ошибки и развилки. Линейный процесс без обработки сбоев
    • 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
    • 20Когда включается. Не сказано, при каком запросе скилл включается
    • 30Повторный запуск. Изменяющих операций: 1, без проверки текущего состояния
    • 40Согласованность. Имя во frontmatter (documentation-fundamentals) не совпадает с папкой (documentation)
    • 100Инструменты и файлы. Внешние инструменты не нужны
    • 100Шаги. Шагов: 15
    • 100Стоимость исполнения. Тело инструкции 1727 токенов
    • low Разделов верхнего уровня: 11. Похоже на несколько доменов в одном скилле

    Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.

    Сигналы качества

    • +5В description нет примеров фраз, по которым скилл должен срабатывать
    • +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
    • +3Формат ответа не описан: модель каждый раз решает сама
    • +1Лицензия не указана
    • +2Инструкции на одном языке
    • +3Длина description 179 символов: достаточно сигнала, не съедает бюджет
    • +4Структура: 27 заголовков
    • +3Пошаговые инструкции: 15 пунктов
    • +4Есть примеры (19 блоков кода)

    База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 84.