SKILLEMALL.ai
GitHub ↗ EN Войти

AC codebase-documenter

Этот навык следует использовать при написании документации для кодовых баз, включая файлы README, документацию по архитектуре, комментарии к коду и документацию API. Используйте этот навык, когда пользователи запрашивают помощь в документировании своего кода, создании руководств для начинающих, объяснении структуры проекта или повышении доступности кодовых баз для новых разработчиков. Навык предоставляет шаблоны, лучшие практики и структурированные подходы для создания четкой, удобной для начинающих документации.

машинный переводПоказать оригиналСкрыть оригинал«This skill should be used when writing documentation for codebases, in…»

This skill should be used when writing documentation for codebases, including README files, architecture documentation, code comments, and API documentation. Use this skill when users request help documenting their code, creating getting-started guides, explaining project structure, or making codebases more accessible to new developers. The skill provides templates, best practices, and structured approaches for creating clear, beginner-friendly documentation.

modbender/skill-library-mcp Agent Skills автор: modbender MIT 9 файлов тело ≈ 2 891 токенов Открыть источникgithub.com↗ проанализирован 2 дн назад

Этот навык следует использовать при написании документации для кодовых баз, включая файлы README, документацию по архитектуре, комментарии к коду и…

Как процесс C 50/100 · Есть пробелы — слабые места: когда включается, входы и предусловия, ошибки и развилки

ГенераторТексты и документыРазработкатип и темы размечены автоматически по тексту скилла
Запускается в: OpenClaw 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) Goose OpenCode
JSON
Технический рейтинг
A
95/100
безопасность, качество, тесты
Безопасность 60%
97
Качество 40%
91
Прогон на моделях
не было
Процессный рейтинг
C
50/100
Есть пробелы
Входы и предусловия вес 11
0
Ошибки и развилки вес 10
0
Отчётность по ходу вес 2
0
три самых слабых из десяти параметров · все десять

Как улучшить

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

    Находки guard · 3

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

    Средние и низкие: 3
    • низкая Утечка данных read-dotenv assets/templates/README.template.md:31
      Чтение файла .env
      cp .env.example .env
    • низкая Секреты в коде secret-password-literal references/documentation_guidelines.md:215
      Захардкоженный пароль / ключ (возможно, пример)
      API_KEY=sk_t…abc
    • низкая Секреты в коде secret-password-literal references/documentation_guidelines.md:222
      Захардкоженный пароль / ключ (возможно, пример)
      API_KEY=sk_l…xyz

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

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

    ✓ По спецификации Agent Skills замечаний нет

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

    • 0Входы и предусловия. Не сказано, что нужно иметь на входе
    • 0Ошибки и развилки. Линейный процесс без обработки сбоев
    • 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
    • 20Когда включается. Не сказано, при каком запросе скилл включается
    • 30Повторный запуск. Изменяющих операций: 12, без проверки текущего состояния
    • 60Инструменты и файлы. Используются инструменты (web), но во frontmatter они не объявлены
    • 60Результат и критерий готовности. Формат результата описан, критерия завершения нет
    • 85Шаги. Шагов: 71, расплывчатых формулировок: 1
    • 100Согласованность. Имя и обязательные поля на месте
    • 100Стоимость исполнения. Тело инструкции 2891 токенов

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

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

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

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