OpenSpecРазработка, управляемая спецификациями, для ИИ-ассистентов
Легковесная спецификация для создания и управления проектами ИИ-ассистентов.
Легковесная спецификация для создания и управления проектами ИИ-ассистентов.
features:
Добро пожаловать. Это центральный ресурс для всего, что связано с OpenSpec.
OpenSpec помогает вам и вашему ИИ-ассистенту по программированию согласовать, что именно нужно создавать, до написания любого кода. Вы описываете изменения, ИИ составляет краткую спецификацию и список задач, вы оба смотрите на один и тот же план, и только потом начинается работа. Больше не придется обнаруживать на полпути, что ИИ создал не то, что нужно.
Если вы не будете читать ничего больше, ознакомьтесь с этими двумя страницами:
/opsx:propose (подсказка: в чате с ИИ, а не в терминале). С этим почти каждый сталкивается хотя бы раз.Вторая страница важнее, чем кажется на первый взгляд. У OpenSpec есть две составляющие: инструмент командной строки, который вы запускаете в терминале, и слэш-команды, которые вы отправляете своему ИИ-ассистенту. Знание разницы между ними избавит вас от самой распространенной путаницы.
Лучшая привычка, которую стоит выработать в первую очередь: если вы не уверены, что нужно создавать, начните с
/opsx:explore. Это безрисковый мысленный партнер, который читает ваш код, взвешивает варианты и превращает размытую идею в конкретный план до создания любых артефактов или кода. В руководстве Сначала исследуйте это подробно разбирается.
Я совершенно новичок. Начните с Начала работы, затем просмотрите Основные концепции вкратце. Если что-то покажется вам непонятным, рядом всегда есть Часто задаваемые вопросы и Глоссарий.
У меня есть проблема, но нет плана. Это самый распространенный случай, и для него есть отдельное руководство: Сначала исследуйте. Используйте /opsx:explore, чтобы обсудить его с ИИ, прежде чем принимать какие-либо решения.
У меня большой существующий код. Вам не нужно документировать весь код сразу. В руководстве Использование OpenSpec в существующем проекте показано, как начать работу с реальным кодом существующего проекта, не пытаясь охватить необъятное.
Мне просто нужно, чтобы все заработало. Установите инструмент, выполните openspec init, затем ознакомьтесь с разделом Как работают команды, чтобы ваша первая слэш-команда попала в нужное место.
Я учусь на примерах. На странице Примеры и рецепты показано, как выполнить реальные изменения от начала до конца: добавление небольшой функции, исправление ошибки, рефакторинг, исследование.
ИИ только что составил план — что делать дальше? Прочитайте его. В разделе Проверка изменений описан двухминутный обзор, который позволяет заметить ошибку в плане, пока исправление еще не требует больших затрат, а в разделе Написание качественных спецификаций разбирается, из чего состоит план, достойный утверждения.
Я работаю в команде. В разделе Использование OpenSpec в команде показано, как изменение соотносится с веткой и пулл-реквестом, и как члены команды проверяют план до написания кода.
Я перешел со старого рабочего процесса. В Руководстве по миграции объясняется, что изменилось и почему, и гарантируется, что ваши существующие работы не пострадают.
Я хочу адаптировать инструмент под процессы моей команды. В разделе Настройка описана конфигурация проекта, пользовательские схемы и общий контекст.
Что-то сломалось. В разделе Устранение неполадок собраны распространенные ошибки, с которыми сталкиваются пользователи, и способы их исправления.
| Документ | Что вы получите |
|---|---|
| Начало работы | Установите, инициализируйте и выполните ваше первое изменение от начала до конца |
| Сначала исследуйте | Используйте /opsx:explore, чтобы обдумать идею, прежде чем приступать к ее реализации |
| Как работают команды | Где выполняются слэш-команды, что означает «интерактивный режим», разница между терминалом и чатом |
| Основные концепции вкратце | Вся ментальная модель на одной странице: спецификации, изменения, дельты, архив |
| Установка | npm, pnpm, yarn, bun, Nix и способ проверить, что установка прошла успешно |
| Документ | Что вы получите |
|---|---|
| Рабочие процессы | Распространенные паттерны и когда использовать каждую команду |
| Примеры и рецепты | Полные пошаговые руководства по реальным изменениям, готовые для копирования и вставки |
| Написание качественных спецификаций | Как выглядят сильные требования и сценарии, и как подобрать правильный размер для изменения |
| Проверка изменений | Двухминутный обмотр составленного плана до написания любого кода |
| Использование OpenSpec в команде | Как изменения соотносятся с ветками, пулл-реквестами и проверкой |
| Использование OpenSpec в существующем проекте | Внедрение OpenSpec в большой существующий проект без лишних усилий |
| Редактирование и итерация изменений | Обновление артефактов, возврат к предыдущим версиям, согласование ручных правок |
| Команды | Справочник по всем слэш-командам /opsx:* |
| CLI | Справочник по всем терминальным командам openspec |
| Документ | Что вы получите |
|---|---|
| Концепции | Развернутое объяснение спецификаций, изменений, артефактов, схем и архива |
| Рабочий процесс OPSX | Почему рабочий процесс является гибким, а не фазовым, плюс углубленный разбор архитектуры |
| Глоссарий | Определение всех терминов в одном месте |
| Документ | Что вы получите |
|---|---|
| Настройка | Конфигурация проекта, пользовательские схемы, общий контекст |
| Многоязычность | Генерация артефактов на языках, отличных от английского |
| Поддерживаемые инструменты | Более 25 ИИ-инструментов, с которыми интегрируется OpenSpec, и расположение файлов |
| Документ | Что вы получите |
|---|---|
| Часто задаваемые вопросы | Краткие ответы на самые распространенные вопросы пользователей |
| Устранение неполадок | Конкретные решения для конкретных ошибок |
| Руководство по миграции | Переход со старого рабочего процесса на OPSX |
| Документ | Что вы получите |
|---|---|
| Хранилища: руководство пользователя | Планирование в отдельном репозитории, если ваша работа затрагивает несколько репозиториев или команд |
| Контракт агента | Машинночитаемые интерфейсы CLI, которыми управляют агенты |
1. Установка npm install -g @fission-ai/openspec@latest
2. Инициализация cd your-project && openspec init
3. Исследование (в чате с ИИ) /opsx:explore ← необязательно, но очень полезная привычка
4. Предложение (в чате с ИИ) /opsx:propose add-dark-mode
5. Сборка (в чате с ИИ) /opsx:apply
6. Архивация (в чате с ИИ) /opsx:archiveШаги 1 и 2 выполняются в терминале. Остальные шаги выполняются в чате с вашим ИИ-ассистентом. Это разделение — единственное, что стоит запомнить, а в разделе Как работают команды объясняется, почему именно так. Шаг 3 необязателен, но привычка начинать с /opsx:explore, если вы не уверены в результате, является самой ценной.
openspec feedback "ваше сообщение" отправляет обратную связь прямо из терминала (она создает issue на GitHub).Нашли в этой документации что-то неправильное, устаревшее или непонятное? Это ошибка. Создайте issue или пулл-реквест. Улучшения документации — один из самых ценных вкладов, которые вы можете сделать.