Truthmark устанавливает нативные для Git рабочие процессы, с помощью которых AI-агенты разработки создают новую продуктовую и инженерную документацию на основе существующего кода и тестов, актуализируют её после каждого изменения кода и предоставляют вам обычные Markdown-диффы для проверки.
Большинство инструментов документирования останавливаются после генерации. Truthmark предоставляет агентам полный жизненный цикл документации прямо в вашем репозитории:
- **Создавайте новую документацию на основе работающего ПО.** Truth Document анализирует код и тесты, а затем создаёт ограниченную по области продуктовую или инженерную документацию.
- **Автоматически поддерживайте соответствие документации.** Truth Sync запускается при передаче работы агентом после функциональных изменений кода и обновляет достоверные сведения репозитория до завершения задачи.
- **Превращайте документацию обратно в код.** Truth Realize реализует утверждённые truth-документы, сохраняя чистый подход от документации к коду.
- **Восстанавливайте владение по мере роста кодовой базы.** Truth Structure создаёт ограниченные маршруты и начальные документы для новых или перегруженных областей.
- **Проверяйте всё в Git.** Код, решения, контракты, архитектура, эксплуатация и поведение перемещаются вместе с веткой.
Никаких размещённых в облаке баз знаний. Никакой закрытой памяти агентов. Никакой документации, запертой в истории чатов.
## Быстрый старт: создайте свой первый truth-документ
**Требования:** Node.js 24 или новее, Git-репозиторий и поддерживаемый AI-хост разработки для агентских рабочих процессов.
Выполните следующие команды в репозитории, которым должен управлять Truthmark:
`truthmark init` позволяет выбрать Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor или нейтральную к хосту настройку интерфейса командной строки.
Теперь попросите настроенного агента задокументировать одно реальное поведение:
```text
/truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
```
Truth Document создаёт новый ограниченный по области truth-документ, если его ещё нет, обновляет существующий документ-владелец, если он есть, и при необходимости обновляет маршрутизацию. Функциональный код при этом не изменяется.
Точные пути определяются структурой владения вашего репозитория. Новые файлы отображаются в `git status`, а изменения отслеживаемых файлов — в `git diff`.
Способ запуска зависит от хоста. OpenCode использует `/skill truthmark-document`, Antigravity — `@truthmark-document`, а другие поддерживаемые хосты используют свои нативные интерфейсы навыков или slash-команд. Точные команды приведены в [таблице платформ](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md#supported-agent-platforms).
Для скриптов и непрерывной интеграции передавайте выбранные платформы явно:
Выберите `none` в интерактивном режиме или выполните `truthmark init --clear-platforms`, чтобы репозиторий оставался нейтральным к хосту. Платформы агентов можно добавить позже, повторно запустив `truthmark init`.
Интерфейс командной строки Truthmark устанавливает и проверяет контракт репозитория. Ваш агент разработки анализирует доказательства и работает с документацией через установленные нативные для хоста рабочие процессы.
| **Truth Document** | Существующему коду нужна документация | Создаёт или обновляет продуктовую и инженерную документацию, основанную на доказательствах |
| **Truth Sync** | Изменился функциональный код | До передачи работы синхронизирует связанную документацию и маршрутизацию |
| **Truth Structure** | Новой области нужен владелец или существующая документация стала слишком широкой | Создаёт ограниченные маршруты и каркасы начальных документов |
| **Truth Realize** | Утверждённый truth-документ должен стать работающим ПО | Обновляет функциональный код на основе документации |
| **Truth Check** | Достоверность репозитория нужно проверить | Сообщает о проблемах маршрутизации, владения, доказательств и документации |
| **Truthmark Portal** | Команде нужен удобный для просмотра сайт документации | Создаёт версионируемое статическое HTML-представление на основе truth-документов Markdown |
Truthmark устанавливает эти рабочие процессы как нативные поверхности репозитория для Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity и Cursor.
Truthmark умеет создавать документацию о возможностях продукта, поведении реализации, программных интерфейсах приложений, архитектуре, рабочих процессах, эксплуатации и тестах. Код и тесты дают доказательства, а ограниченные по области документы Markdown сохраняют результат.
Маршруты связывают области кода с канонической документацией. Когда агенты меняют поведение, Truth Sync знает, где должны находиться соответствующие достоверные сведения, и сохраняет результат удобным для проверки.
Продуктовая истина фиксирует обещания пользователям, границы, решения и критерии приёмки. Инженерная истина фиксирует текущее поведение, контракты, архитектуру, рабочие процессы, эксплуатацию и поведение тестов.
Всё важное находится в версионируемых файлах репозитория. Истина следует за веткой, работает с обычными pull request и остаётся видимой каждому сопровождающему и агенту разработки.
Truthmark не нужны размещённый сервис, фоновый процесс, база данных, векторное хранилище или сервер Model Context Protocol. Репозиторий содержит собственный рабочий процесс документирования.
Truthmark создан для сопровождающих и инженерных команд, которые уже используют AI-агентов разработки и хотят, чтобы репозиторий продолжал говорить правду так же быстро, как меняется код.
