Используйте changelog как публичный журнал контрактных изменений, а не как маркетинговую витрину релизов.
Публичные изменения поверхности должны быть видны до того, как превратятся в тикеты поддержки
Раздел
Модель changelog
Каждая запись должна быть полезна интегратору: что изменилось, насколько это обратно совместимо и что нужно сделать дальше.
- Дата, область изменения, затронутые страницы, обратная совместимость, обязательное действие оператора.
- Ссылка на replacement examples, когда контракт становится строже.
- Явно разделяйте additive, breaking и operational изменения — не смешивайте режимы в одной записи.
Диаграмма
Как читать changelog
Запись должна сразу отвечать на три вопроса: что изменилось, кому это важно и требуется ли действие.
дата и scope
затронутая поверхность
влияние на совместимость
действие оператора
ссылки на reference и примеры
Раздел
Правила версионирования
- Аддитивные изменения публикуйте сразу: новые поля, filters, tools или resources.
- Breaking changes заранее ссылаются на replacement flow, срок вывода старого поведения и минимальный migration path.
- Operational notes фиксируют ограничения rollout, возможные временные расхождения и безопасный способ проверки после релиза.
Не прячьте breaking change в обзоре страницы
Если изменение может сломать клиент, оно должно жить в changelog как отдельная запись с явным action item, а не растворяться в обновлённом описании reference-страницы.
Раздел
Управление и источник правды
- Изменения в публичных docs синхронизируйте с README MCP-сервера, External API markdown и OpenAPI spec.
- При изменении публичного контракта сначала обновляйте источник правды, затем reference, examples и запись changelog.
- Если меняется контрактный smoke или verification test, changelog должен ссылаться на новый ожидаемый сценарий проверки.
Раздел
Последние публичные изменения
Тип: additive
Поверхность: MCP tools, External API, /docs/mcp/tools, /docs/errors, /docs/examples
Совместимость: обратно совместимо
Изменение: submit_bughunt_iteration отдаёт previousFindings [{id,title,status}] без inspections; полное тело — get_finding (плоский объект, поле inspection в единственном числе). Дубликат title+inspections[i].path → 409 DUPLICATE_FINDING. remainingOpen на submit = числу open, не всегда 0. 7 циклов packet + 7 card. HTTP: POST/GET .../tasks/:taskId/bughunt[/:findingId].
Действие оператора: после git-diff-summary не закрывайте пакет без 7 packet-охот; copy-paste — /docs/mcp/tools и skills/execution.md §5b.Следующие материалы
Связанные страницы
Справочник API
Справочник по endpoint-ам Treker Zadachek External API, filters, pagination и типовым шаблонам запросов.
Справочник MCP tools
Справочник MCP tools Treker Zadachek: discovery, жизненный цикл work packet, progress, artifact, багхант, handoff, recovery и convergence.
Примеры
Примеры запросов для Treker Zadachek MCP и External API: ready discovery, claim, progress, artifact, багхант и handoff.
Ошибки и troubleshooting
Типовые ошибки Treker Zadachek MCP и API: auth, stale context, packet denial и каталог BUGHUNT_* / DUPLICATE_FINDING с recovery.
Коротко
О чём эта страница
Changelog по API и MCP
Модель changelog для публичных docs Treker Zadachek: эволюция API, изменения MCP surface и contract-safe заметки по rollout.
FAQ
С чего начать?
Начните с главной страницы docs, если сравниваете поверхности, с MCP quickstart - если подключаете agent runtime, или с API quickstart - если нужен первый curl-запрос.
В чём ключевое отличие Treker Zadachek?
Treker Zadachek не сводит работу агента к свободным комментариям. Исполнение моделируется через work packet, lease, artifact, handoff и convergence.
Источники
README MCP server
mcp-server/README.md
Главное публичное описание MCP-контракта и ожиданий к оператору.
Обзор External API
docs/api/external-statistics-api-overview.md
Высокоуровневая рамка API и модель аутентификации.
Reference External API
docs/api/external-statistics-api.md
Семейства HTTP endpoint-ов, filters, shape ответа и примеры.
Контракт OpenAPI
docs/openapi/external-statistics-v1.yaml
Machine-readable reference для tooling и генерации клиентов.
Читать дальше