Документация

Контекст проекта

Прикрепите документы, политику и ссылки, которые агент не сможет определить только по репозиторию.

Агенты анализируют ваш код. Контекст — это место, где хранятся данные, не отражённые в коде: решения, ограничения и правила, действующие за его пределами.

Причины необходимости использования контекста описаны в разделе Контекст проекта в разделе «Основные понятия». На этой странице рассказывается о его управлении.

Добавление контекста

Откройте раздел « Контекст » вашего проекта и добавьте запись. Каждая запись имеет заголовок и текст, их можно редактировать или удалять позже.

Хорошие записи должны быть краткими, конкретными и стабильными. Сюда относятся решения по архитектуре, стилевые конвенции, контракты API, границы ответственности и явные запреты. Нарратив для онбординга и всё, что уже очевидно из репозитория, сюда не попадает.

Сохраняйте записи раздельными и с понятными названиями

Одна запись на каждую тему, с заголовком, отражающим её содержание. Записи «Конвенции обработки ошибок» и «Замороженные модули» легко находить; а вот одна общая запись «Примечания», включающая оба аспекта, — нет.

Это важно, потому что контекст загружается выборочно в зависимости от текущей задачи — см. Постепенное развитие навыков. Хорошо разделённые записи позволяют загружать нужную информацию для конкретной задачи.

Ссылки

Помимо текстовых записей можно прикреплять ссылки — гиперссылки и документы, ведущие к материалам, хранящимся в других местах. Используйте их, когда актуальная версия документа находится в wiki или инструменте для дизайна, и вам не нужно создавать дубликат, который быстро устареет.

Контекст для конкретной задачи

Контекст проекта применяется ко всему в нём. Если какой-то материал относится лишь к одной задаче — тикету, отчёту клиента или документу по дизайну — прикрепляйте его к этой задаче. Запись о задаче, оставленная в контексте проекта, станет мешающим фактором для всех последующих задач.

Сохранение актуальности контекста

Устаревший контекст хуже, чем отсутствующий, ведь агенты считают его авторитетным. При изменении конвенции обновляйте соответствующую запись в том же коммите, что и код.

Просмотр существующего контекста

Иногда читайте свой контекст как новичок. Записи накапливаются, и та, что была создана год назад во время миграции, теперь может вводить в заблуждение.