AF codebase-documenter
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.
Как процесс F 34/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: assets/templates/, assets/templates/README.template.md, assets/templates/ARCHITECTURE.template.md
Как улучшить
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 2. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
missing-refссылка на отсутствующий файл: assets/templates/ - предупреждение
missing-refссылка на отсутствующий файл: assets/templates/README.template.md - предупреждение
missing-refссылка на отсутствующий файл: assets/templates/ARCHITECTURE.template.md - предупреждение
missing-refссылка на отсутствующий файл: assets/templates/API.template.md - предупреждение
missing-refссылка на отсутствующий файл: references/documentation_guidelines.md - предупреждение
missing-refссылка на отсутствующий файл: references/visual_aids_guide.md - заметка
frontmatter-keyнеизвестное поле фронтматтера "requires.env"
Процессный рейтинг: все десять параметров 34/100
- 0Инструменты и файлы. Не хватает 6 файла(ов): assets/templates/, assets/templates/README.template.md, assets/templates/ARCHITECTURE.template.md
- 0Входы и предусловия. Не сказано, что нужно иметь на входе
- 0Ошибки и развилки. Линейный процесс без обработки сбоев
- 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 12, без проверки текущего состояния
- 40Согласованность. Имя во frontmatter (codebase-documenter) не совпадает с папкой (alv-codebase-documenter)
- 60Результат и критерий готовности. Формат результата описан, критерия завершения нет
- 85Шаги. Шагов: 71, расплывчатых формулировок: 1
- 100Стоимость исполнения. Тело инструкции 2851 токенов
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 463 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 23 заголовков
- +3Пошаговые инструкции: 71 пунктов
- +3Формат ответа описан явно
- +4Есть примеры (8 блоков кода)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 74.