BF diataxis-docs-framework
Лучшие практики, шаблоны и фреймворки для корпоративной технической документации, предназначенные для разработчиков и партнеров. Охватывает архитектуру контента (четыре квадранта Diataxis), 14 типов контента (руководства, инструкции, справочники API, документация SDK, руководства по миграции, списки изменений, плейбуки, руководства по интеграции, устранение неполадок, архитектурные документы), подключаемые стили письма (Diataxis, Google, Microsoft, Stripe, Canonical, Minimal), информационную архитектуру, рабочие процессы docs-as-code, аудит документации, контрольный список антипаттернов и стратегию пользовательского опыта разработчика (DX). 27 правил, 5 ссылок, 6 руководств по стилю. Базовый уровень: Diataxis + Google OpenDocs + Good Docs Project. Триггеры: «написать документацию», «документировать это», «документация API», «документация для разработчиков», «руководство по миграции», «список изменений», «руководство», «инструкция», «справочная документация», «стратегия документации», «аудит документации», «информационная архитектура», «опыт разработчика», «документация для партнеров», «документация SDK», «плейбук», «руководство по устранению неполадок», «руководство по интеграции», «быстрый старт», «начало работы», «техническое письмо», «docs-as-code», «DX», упоминания «Diataxis», «Good Docs Project» или «Google OpenDocs».
машинный переводПоказать оригиналСкрыть оригинал«Enterprise technical documentation best practices, patterns, and frame…»
Enterprise technical documentation best practices, patterns, and frameworks for developer and partner adoption. Covers content architecture (Diataxis four quadrants), 14 content types (tutorials, how-to guides, API reference, SDK docs, migration guides, changelogs, runbooks, integration guides, troubleshooting, architecture docs), pluggable writing styles (Diataxis, Google, Microsoft, Stripe, Canonical, Minimal), information architecture, docs-as-code workflows, documentation audit, anti-patterns checklist, and developer experience (DX) strategy. 27 rules, 5 references, 6 style guides. Baseline: Diataxis + Google OpenDocs + Good Docs Project. Triggers on: "write docs", "document this", "API docs", "developer docs", "migration guide", "changelog", "tutorial", "how-to guide", "reference docs", "documentation strategy", "docs audit", "information architecture", "developer experience", "partner docs", "SDK documentation", "runbook", "troubleshooting guide", "integration guide", "quickstart", "getting started", "technical writing", "docs-as-code", "DX", mentions of "Diataxis", "Good Docs Project", or "Google OpenDocs".
Лучшие практики, шаблоны и фреймворки для корпоративной технической документации, предназначенные для разработчиков и партнеров.
Как процесс F 52/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: references/styles/[style].md
Как улучшить
- Сократите description до 1024 символов.
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 42. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- ошибка
description-longdescription 1132 символов, лимит 1024 - предупреждение
missing-refссылка на отсутствующий файл: references/styles/[style].md - заметка
frontmatter-keyнеизвестное поле фронтматтера "agentic"
Процессный рейтинг: все десять параметров 52/100
- 0Инструменты и файлы. Не хватает 1 файла(ов): references/styles/[style].md
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
- 30Повторный запуск. Изменяющих операций: 2, без проверки текущего состояния
- 40Согласованность. Имя во frontmatter (diataxis-docs-framework) не совпадает с папкой (developer-docs-framework)
- 70Когда включается. Сказано, когда применять, но не сказано, когда не стоит
- 70Входы и предусловия. Входные данные и предусловия перечислены
- 100Шаги. Шагов: 33
- 100Ошибки и развилки. Развилок: 1, есть раздел про ошибки
- 100Стоимость исполнения. Тело инструкции 3964 токенов
- medium Правила безопасности и запреты внутри скилла: их место в системном промпте, здесь они не защищают
- low Разделов верхнего уровня: 17. Похоже на несколько доменов в одном скилле
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Длина description 1131: рекомендуется 120–800 символов
- +3Формат ответа не описан: модель каждый раз решает сама
- +2Инструкции на одном языке
- +5В description 25 примера фраз-триггеров в кавычках
- +4Структура: 25 заголовков
- +3Пошаговые инструкции: 33 пунктов
- +4Есть примеры (3 блоков кода)
- +4Справочные файлы упоминаются в инструкциях (8 из 32)
- +1Лицензия указана
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 59.