Рабочий процесс Spec-First
Определяйте требования до написания кода.
OpenSpecРазработка на основе спецификации для AI-ассистентов
Легковесная спецификация для создания и управления проектами AI-ассистентов.
Легковесная спецификация для создания и управления проектами AI-ассистентов.
Добро пожаловать. Это домашняя страница всего, что связано с OpenSpec.
OpenSpec помогает вам и вашему AI-кодирующему ассистенту согласовать, что нужно создать, прежде чем будет написана какая-либо строка кода. Вы описываете изменение, ИИ составляет краткую спецификацию и список задач, вы оба смотрите на один и тот же план, а затем работа выполняется. Больше никаких ситуаций, когда в процессе выясняется, что ИИ создал не то.
Если вы ничего больше не прочитаете, прочтите эти две страницы:
/opsx:propose (подсказка: в вашем AI-чате, а не в терминале). Это сбивает почти всех один раз.Вторая страница важнее, чем кажется. OpenSpec состоит из двух частей: инструмента командной строки, который вы запускаете в терминале, и слеш-команд, которые вы даете своему AI-ассистенту. Знание того, что к чему относится, сэкономит вам самую распространенную минуту замешательства.
Лучшая привычка для формирования в первую очередь: когда вы не уверены, что нужно создать, начните с
/opsx:explore. Это партнер по мышлению без риска, который читает ваш код, взвешивает варианты и превращает расплывчатую идею в конкретный план до того, как появится какой-либо артефакт или код. Руководство Explore First обосновывает это.
Я новичок. Начните с Getting Started, а затем просмотрите Core Concepts at a Glance. Если что-то кажется загадочным, рядом находятся FAQ и Glossary.
У меня есть проблема, но нет плана. Это распространенный случай, и для него есть специальный ответ: Explore First. Используйте /opsx:explore, чтобы продумать это с ИИ, прежде чем что-либо фиксировать.
У меня большая существующая кодовая база. Вам не нужно документировать всё. В Using OpenSpec in an Existing Project показано, как начать работу над реальным "кодом коричневого поля" (brownfield code), не пытаясь решить все проблемы сразу.
Я просто хочу, чтобы это заработало. Install, запустите openspec init, а затем прочтите How Commands Work, чтобы ваша первая слеш-команда попала в нужное место.
Я учусь на примерах. Страница Examples & Recipes демонстрирует реальные изменения от начала до конца: небольшую фичу, исправление бага, рефакторинг, исследование.
Я перехожу со старого рабочего процесса. В Migration Guide объясняется, что изменилось и почему, и гарантируется, что ваша существующая работа в безопасности.
Я хочу адаптировать это под процесс моей команды. Customization описывает конфигурацию проекта, пользовательские схемы и общий контекст.
Что-то сломано. Troubleshooting собирает сбои, с которыми сталкиваются люди на самом деле, вместе с исправлениями.
| Документ | Что он дает вам |
|---|---|
| Getting Started | Установка, инициализация и запуск вашего первого изменения от начала до конца |
| Explore First | Использование /opsx:explore для проработки идеи перед фиксацией |
| How Commands Work | Где запускаются слеш-команды, что означает "интерактивный режим", терминал против чата |
| Core Concepts at a Glance | Вся ментальная модель на одной странице: спецификации, изменения, дельты, архив |
| Installation | npm, pnpm, yarn, bun, Nix и как проверить работоспособность |
| Документ | Что он дает вам |
|---|---|
| Workflows | Общие шаблоны и когда использовать каждую команду |
| Examples & Recipes | Полные примеры реальных изменений, готовые к копированию |
| Using OpenSpec in an Existing Project | Применение OpenSpec в крупной кодовой базе "коричневого поля" |
| Editing & Iterating on a Change | Обновление артефактов, возврат назад, согласование ручных правок |
| Commands | Справочник по каждой слеш-команде /opsx:* |
| CLI | Справочник по каждой терминальной команде openspec |
| Документ | Что он дает вам |
|---|---|
| Concepts | Развернутое объяснение спецификаций, изменений, артефактов, схем и архива |
| OPSX Workflow | Почему рабочий процесс является гибким, а не фазовым, плюс глубокий анализ архитектуры |
| Glossary | Каждый термин, определенный в одном месте |
| Документ | Что он дает вам |
|---|---|
| Customization | Конфигурация проекта, пользовательские схемы, общий контекст |
| Multi-Language | Генерация артефактов на языках, отличных от английского |
| Supported Tools | Более 25 AI-инструментов, с которыми интегрируется OpenSpec, и куда попадают файлы |
| Документ | Что он дает вам |
|---|---|
| FAQ | Быстрые ответы на самые частые вопросы |
| Troubleshooting | Конкретные исправления для конкретных сбоев |
| Migration Guide | Переход от устаревшего рабочего процесса к OPSX |
| Документ | Что он дает вам |
|---|---|
| Stores: User Guide | Планирование в собственном репо, когда ваша работа охватывает несколько репозиториев или команд |
| Agent Contract | Машинно-читаемые интерфейсы, управляемые агентами |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← опционально, но отличная привычка
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archiveШаги 1 и 2 выполняются в вашем терминале. Остальное происходит в чате вашего AI-ассистента. Это разделение — единственное, что стоит запомнить, а How Commands Work объясняет, почему это так. Шаг 3 опционален, но начало с /opsx:explore, когда вы не уверены, является привычкой, которую стоит сформировать больше всего.
openspec feedback "your message" отправляет обратную связь прямо из вашего терминала (это открывает проблему в GitHub).Нашли что-то в этой документации, что неверно, устарело или сбивает с толку? Это баг. Откройте проблему или PR. Улучшения документации — одни из самых ценных вкладов, которые вы можете сделать.