Робочий процес Spec-First
Визначайте вимоги до написання коду.
OpenSpecРозробка, керована специфікацією для AI-помічників
Легка специфікація для створення та керування проєктами AI-помічників.
Легка специфікація для створення та керування проєктами AI-помічників.
Ласкаво просимо. Це домашня сторінка всього, що стосується OpenSpec.
OpenSpec допомагає вам та вашому AI-кодинговому помічникові згодити, що будувати, до написання будь-якого коду. Ви описуєте зміни, ШІ складає коротку специфікацію та список завдань, ви обоє дивитеся на один план, а потім відбувається робота. Жодних більше випадків, коли наполовину зрозуміло, що ШІ створив не те.
Якщо ви нічого іншого не прочитаєте, прочитайте ці дві сторінки:
/opsx:propose (підказка: у своєму чаті з ШІ, а не у терміналі). Це плутає майже кожного один раз.Друга сторінка важливіша, ніж здається. 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), не намагаючись вирішити всі проблеми одразу.
Я просто хочу, щоб це працювало. 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 у велику базу існуючого коду (brownfield) |
| 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 виконуються у вашому терміналі. Решта відбувається в чаті вашого помічника ШІ. Цей поділ — єдина річ, яку варто запам'ятати, а How Commands Work пояснює, чому це так. Крок 3 необов'язковий, але початок з /opsx:explore, коли ви не впевнені, — це найцінніша звичка для формування.
openspec feedback "your message" надсилає відгук прямо з вашого терміналу (він відкриває проблему у GitHub).Знайшли щось у цій документації, що є неправильним, застарілим або незрозумілим? Це баг. Створіть проблему або PR. Покращення документації — одні з найцінніших внесків, які ви можете зробити.