Skip to content

OpenSpecРазработка, управляемая спецификациями, для ИИ-ассистентов

Легковесная спецификация для создания и управления проектами ИИ-ассистентов.

features:

  • title: Рабочий процесс, начинающийся с спецификации details: Определяйте требования до написания кода.
  • title: Спроектировано специально для ИИ details: Создано для Claude Code, Cursor, Windsurf и других инструментов.
  • title: Многоязычность details: Документация доступна на нескольких языках.

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

Добро пожаловать. Это центральный ресурс для всего, что связано с OpenSpec.

OpenSpec помогает вам и вашему ИИ-ассистенту по программированию согласовать, что именно нужно создавать, до написания любого кода. Вы описываете изменения, ИИ составляет краткую спецификацию и список задач, вы оба смотрите на один и тот же план, и только потом начинается работа. Больше не придется обнаруживать на полпути, что ИИ создал не то, что нужно.

Если вы не будете читать ничего больше, ознакомьтесь с этими двумя страницами:

  1. Начало работы: установка, инициализация и выкатка вашего первого изменения.
  2. Как работают команды: где именно нужно вводить /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, которыми управляют агенты

Версия для ознакомления за 30 секунд

text
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, если вы не уверены в результате, является самой ценной.

Где еще можно получить помощь

  • Discord: discord.gg/YctCnvvshC для вопросов, предложений и помощи.
  • GitHub Issues: github.com/Fission-AI/OpenSpec/issues для сообщений об ошибках и запросов новых функций.
  • Команда openspec feedback "ваше сообщение" отправляет обратную связь прямо из терминала (она создает issue на GitHub).

Нашли в этой документации что-то неправильное, устаревшее или непонятное? Это ошибка. Создайте issue или пулл-реквест. Улучшения документации — один из самых ценных вкладов, которые вы можете сделать.