Начало работы01 / 16
Знакомство с Noea Code
На этой странице
Noea Code (или просто Noea) помогает проверять, насколько программы, написанные ИИ, отвечают вашим требованиям. Начните с существующей реализации: опирайтесь на требования при проверке поведения и доказательств, разбирайтесь в важных решениях и фиксируйте свои решения для дальнейшей работы.
Начните с одного правила в существующем проекте. Первым требованием может быть правило поведения продукта, архитектурное ограничение или требование к алгоритму.
Требования — это то, чему программа должна продолжать соответствовать. Они остаются важными и после завершения функции. Решив изменить её поведение, вы меняете соответствующую формулировку. Описывать всё приложение необязательно: начните с того, что важно вам.
Свяжите требования с реализацией
Предположим, вы создаёте приложение с ежедневными отметками и пишете:
Выдавать пользователю награду после семи дней отметок подряд.
Так задано условие награды, но несколько решений остаются открытыми: что считать днём, что делать после пропущенной отметки и какую награду выдавать. Реализуя правило, агенту всё равно придётся принять эти решения.
Noea связывает предложение с объяснением реализации. Вы можете прочитать, как код считает дни, открыть ссылки на код или материалы тестирования, подтверждающие объяснение, и найти невыполненные требования или решения, которые стоит обсудить. Если вы решите, что день должен определяться по местной календарной дате пользователя, добавьте это решение в требования, чтобы дальнейшая работа ему соответствовала.
Различайте три вида содержимого
| Содержимое | Назначение | Где найти |
|---|---|---|
| Документы требований | Фиксируют нужное вам поведение и ограничения | Раздел требований на боковой панели; имена файлов заканчиваются на .noea.md |
| Реализация | Код программы, конфигурация и связанные файлы | Связанная папка реализации проекта |
| Описания реализации | Объясняют, как реализация отвечает на часть требований, с доказательствами и замечаниями | Примечания на полях рядом с документом требований |
Документы требований — это файлы Markdown. Их можно отслеживать в Git или редактировать в другом редакторе. Noea хранит описания реализации отдельно и показывает их в примечаниях на полях. В некоторых английских элементах интерфейса документы требований называются Source; это не код в папке реализации.
Следуйте обычному процессу
- Подтвердите основу проверки. Запишите требование, которое хотите проверить, или обсудите его с агентом и утвердите предложенную формулировку.
- Проверьте реализацию. Исследуйте, как существующий код выполняет требование, изучите доказательства и найдите решения, для которых нужно ваше суждение.
- Зафиксируйте решения. Задайте вопрос по конкретному абзацу, добавьте требования, которые хотите сохранить, и продолжайте реализацию и проверку.
Если код уже существует, запишите требование, которое хотите проверить, и запустите Объяснить (Explain). Если его ещё нужно реализовать, воспользуйтесь чатом или действием Реализовать (Realize).
Понятое решение можно принять, не превращая каждую деталь реализации в постоянное требование. Статья Читайте объяснения и доказательства поможет определить, что стоит записать в требования.
Проверка реализации означает сравнение поведения, доказательств и решений с вашими требованиями. Проверка изменения требований означает оценку предложенной формулировки до её принятия в документ. Первая помогает решить, что нужно изменить; вторая фиксирует требования, которые вы решили сохранить.
Поймите роли Noea и агента
Noea предоставляет рабочую область для написания документов, обсуждения решений, проверки изменений и чтения объяснений. Агент читает проект, вызывает инструменты и меняет код. Выберите поддерживаемого агента и используйте доступные у него модели и способы входа.
В процессе работы с предложениями Noea изменения ваших документов требований требуют вашего решения. Вы можете изменить и принять предложение либо отклонить его. Изменения кода и выполнение команд зависят от возможностей агента и настроек разрешений.
Описания реализации не заменяют тесты или проверку при работе с приложением. Проверяйте доказательства важных особенностей поведения и при необходимости подтверждайте их самостоятельно.
Начните с небольшого, содержательного вопроса
Выберите узкий вопрос с наблюдаемым результатом: когда выдаётся награда, как обрабатывается нехватка товара или какое ограничение должен соблюдать API. Для остальной части проекта можно продолжать привычный процесс разработки.
Затем установите приложение и подготовьтесь к работе, после чего перейдите к статье Ваша первая проверка.